Install Git Win10 #77

Manually merged
Codeberg-e.V. merged 1 commits from ivan-paleo/Documentation:install-git into install-git 2 months ago

Instructions to install Git on Win10 (with screenshots).
The instructions are missing for Linux/macOS but the structure is there.

Instructions to install Git on Win10 (with screenshots). The instructions are missing for Linux/macOS but the structure is there.
lhinderberger requested changes 2 years ago
lhinderberger left a comment

Thank you for your contribution. Find below a list of suggested changes:

Thank you for your contribution. Find below a list of suggested changes:
key: InstallGit
title: Install Git
parent: GettingStarted
order: 50

We should place this between "First Steps" and "First Repository", so this should be 25.

We should place this between "First Steps" and "First Repository", so this should be 25.
lhinderberger marked this conversation as resolved
order: 50
---
Codeberg is based on the [Git](https://git-scm.com/) [version control](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control) system. This is why you should install Git.

I'd change the wording to "Projects on Codeberg use Git as their version control system. If you want to contribute sourcecode, it is a good idea to install Git at this point."

I'd change the wording to "Projects on Codeberg use Git as their version control system. If you want to contribute sourcecode, it is a good idea to install Git at this point."
lhinderberger marked this conversation as resolved
Codeberg is based on the [Git](https://git-scm.com/) [version control](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control) system. This is why you should install Git.
Git runs on every OS. You can download it directly from the [Git website](https://git-scm.com/downloads).

let's add ", or from your operating system's package manager (if available)."

let's add ", or from your operating system's package manager (if available)."
lhinderberger marked this conversation as resolved
**Disclaimer**: we try to keep these instructions up-to-date, but you might need to adjust them to your machine/OS.
## Windows 10
There are several possiblities to install Git on Windows. The easiest (IMHO) is shown here.

I would drop the (IMHO) and instead write: "An easy one is to use Git's install wizard, shown here".

I would drop the (IMHO) and instead write: "An easy one is to use Git's install wizard, shown here".
lhinderberger marked this conversation as resolved
There are several possiblities to install Git on Windows. The easiest (IMHO) is shown here.
### Admin or user?
For some Git clients (see below) and some cases, it is recommended to install Git as administrator on your machine. It is also possible to install as user, but this might need some extra configuration steps later.

I suggest we add a link around "below" like this: [below](#git-clients) with <a name="git-clients"></a> added between lines 67 and 68.

I suggest we add a link around "below" like this: ```[below](#git-clients)``` with ```<a name="git-clients"></a>``` added between lines 67 and 68.

Also, can you elaborate on the cases where install as administrator is necessary?

Also, can you elaborate on the cases where install as administrator is necessary?
Poster

I didn't thing the <a name="git-clients"></a> part would be necessary. Doesn't Markdown creates such internal links by itself? In R Markdown at least it's not necessary :)

My understanding (only based on what I've read, rather than my own experience) is that, in the case of RStudio, it will automatically find the path to the Git executable if installed as admin. If installed as user, you might need to adjust this path in the settings later on. But maybe not. I have reworded, but should I delete this part instead?

I didn't thing the `<a name="git-clients"></a>` part would be necessary. Doesn't Markdown creates such internal links by itself? In R Markdown at least it's not necessary :) My understanding (only based on what I've read, rather than my own experience) is that, in the case of RStudio, it will automatically find the path to the Git executable if installed as admin. If installed as user, you might need to adjust this path in the settings later on. But maybe not. I have reworded, but should I delete this part instead?

Some markdown implementations auto-generate heading anchors, others don't. Appearently Eleventy doesn't out-of-the-box, but I'm curious whether there's a way to have it auto-generate anchors -> #83

Some markdown implementations auto-generate heading anchors, others don't. Appearently Eleventy doesn't out-of-the-box, but I'm curious whether there's a way to have it auto-generate anchors -> #83

I would say we can leave the "install as administrator" part in :)

I would say we can leave the "install as administrator" part in :)
lhinderberger marked this conversation as resolved
For some Git clients (see below) and some cases, it is recommended to install Git as administrator on your machine. It is also possible to install as user, but this might need some extra configuration steps later.
### Install
If you want to install as user, just log in with your user account and run the installer.

first occurrence of user -> regular user

first occurrence of user -> regular user
lhinderberger marked this conversation as resolved
### Install
If you want to install as user, just log in with your user account and run the installer.
To install with adminitrator rights, either log in as administrator, or run the installer as administrator. In the latter case, right-click on the installer, select `Run as administrator` and enter your credentials:

Typo: adminitrator -> administrator

Typo: adminitrator -> administrator
lhinderberger marked this conversation as resolved
To install with adminitrator rights, either log in as administrator, or run the installer as administrator. In the latter case, right-click on the installer, select `Run as administrator` and enter your credentials:
![win-run-admin](/assets/images/getting-started/install-git/Win_run-as-admin.PNG)
Follow the steps. If you are not an expert, just accept the defaults.

Suggested wording: From there, follow the steps in the setup wizard. It is okay to just accept the defaults, when in doubt.

Suggested wording: From there, follow the steps in the setup wizard. It is okay to just accept the defaults, when in doubt.
lhinderberger marked this conversation as resolved
There are two steps for which you have to pay attention:
1. Choose your editor:
![win-editor](/assets/images/getting-started/install-git/Win_editor.PNG)

Why does this need special attention? (Please add a paragraph on why)

Why does this need special attention? (Please add a paragraph on why)
lhinderberger marked this conversation as resolved
2. PATH environment:
![win-path](/assets/images/getting-started/install-git/Win_PATH.PNG)
Make sure that Git can be used by 3rd party software (Git clients). It is recommended (and the default) anyway.

This rendered a bit wrong when testing - I unfortunately cannot figure out how to add a screenshot here though.

Maybe it can get fixed by adding a blank link between lines 34 and 35.

Also, I'd extend the wording just a little bit: "This makes sure that Git can...."

This rendered a bit wrong when testing - I unfortunately cannot figure out how to add a screenshot here though. Maybe it can get fixed by adding a blank link between lines 34 and 35. Also, I'd extend the wording just a little bit: "This makes sure that Git can...."
lhinderberger marked this conversation as resolved
![win-path](/assets/images/getting-started/install-git/Win_PATH.PNG)
Make sure that Git can be used by 3rd party software (Git clients). It is recommended (and the default) anyway.
This is surely not quite normal, but everytime I install it, I get an error at the end that it cannot display the release notes:

I suggest you move this into an info box by putting it into a Markdown Blockquote like this:

Article article article article.

> Infobox infobox infobox
> infobox infobox
> infobox

Article article

Also, I'd rephrase this to drop the personal viewpoint implied by the "I". Maybe:
"You may get the error message displayed below, that the release notes cannot be displayed. That error message can be safely ignored. You can find the release notes in 'Start Menu..."

I suggest you move this into an info box by putting it into a Markdown Blockquote like this: ``` Article article article article. > Infobox infobox infobox > infobox infobox > infobox Article article ``` Also, I'd rephrase this to drop the personal viewpoint implied by the "I". Maybe: "You may get the error message displayed below, that the release notes cannot be displayed. That error message can be safely ignored. You can find the release notes in 'Start Menu..."
lhinderberger marked this conversation as resolved
You can safely ignore this error. You can find the release notes in `Start Menu > Git > Git Release Notes`.
### Run
Windows is special (and not in a good way) when it comes to the shell.

I strongly suggest to drop at least the (and not in a good way), if not this entire sentence because it's current wording could be misunderstood as carrying a sense of arrogance towards Windows users, which would not be very welcoming in the Getting Started guide.

I strongly suggest to drop at least the `(and not in a good way)`, if not this entire sentence because it's current wording could be misunderstood as carrying a sense of arrogance towards Windows users, which would not be very welcoming in the Getting Started guide.
lhinderberger marked this conversation as resolved
### Run
Windows is special (and not in a good way) when it comes to the shell.
Git can be used through the `Command Prompt` (the native Windows command line interpreter), the `Windows Powershell` (the "replacement" of the `Command Prompt`), the interface of your Git client, or `Git Bash`. The latter two options are recommended.

native -> traditional

native -> traditional
lhinderberger marked this conversation as resolved
`Git Bash` is what comes with your Git installation. You can access it from the Start Menu: `Git > Git Bash`.
### Configure
Git is now installed and running, but you need to connect it to Codeberg. This is easily done with `Git Bash`:

"connect it to Codeberg" - Codeberg is not directly involved in this step, although is of course is necessary to set up name and email for Gitea to recognize where the contributions came from.

I'd rephrase to:

"You now managed to get Git up and running. The first thing you must do, before you can use your fresh installation of Git, is to tell Git your name and email address. You only have to do this once. This is easily done..."

"connect it to Codeberg" - Codeberg is not directly involved in this step, although is of course is necessary to set up name and email for Gitea to recognize where the contributions came from. I'd rephrase to: "You now managed to get Git up and running. The first thing you must do, before you can use your fresh installation of Git, is to tell Git your name and email address. You only have to do this once. This is easily done..."
lhinderberger marked this conversation as resolved
```
The username can be anything, but it is important that the email is the same as the one you use on Codeberg.
The first time you push/pull (see [Clone & Commit via HTTP](content/git/clone-commit-via-http)), it will ask for your Codeberg credentials. If you did not change this setting during installation, these credentials will be saved by Windows in its [Credential Manager](https://support.microsoft.com/en-us/help/4026814/windows-accessing-credential-manager). This is also where you have to go in order to change them.

Broken link "content/git/clone-commit-via-http" -> "/git/clone-commit-via-http"

Broken link "content/git/clone-commit-via-http" -> "/git/clone-commit-via-http"
Poster

I edited, but wasn't the problem just the missing leading slash? Adding the folder "content" cannot hurt, right?

I edited, but wasn't the problem just the missing leading slash? Adding the folder "content" cannot hurt, right?

When generating the documentation site, the content prefix is dropped - what's part of the content directory in the input, will be located at the root of the output.

I'm not too happy myself with this slightly design decision, but it enables us to have a clear separation in directory structure between text content and assets.

When generating the documentation site, the `content` prefix is dropped - what's part of the `content` directory in the input, will be located at the root of the output. I'm not too happy myself with this slightly design decision, but it enables us to have a clear separation in directory structure between text content and assets.
Poster

But then we should edit all links I have added, because for most of them I have the whole relative path (including /content)

But then we should edit all links I have added, because for most of them I have the whole relative path (including `/content`)
lhinderberger marked this conversation as resolved
The first time you push/pull (see [Clone & Commit via HTTP](content/git/clone-commit-via-http)), it will ask for your Codeberg credentials. If you did not change this setting during installation, these credentials will be saved by Windows in its [Credential Manager](https://support.microsoft.com/en-us/help/4026814/windows-accessing-credential-manager). This is also where you have to go in order to change them.
### Update
To update Git, the easiest way is to download and run the latest version of the installer and follow the previous steps. Make sure that you run the new installer with the same rights (administrator or user) as for the original installation. If not, it will be installed twice and that will create a mess.

If I remember correctly, Git reminded the user of a new version on Windows. We should add a paragraph about that.

If I remember correctly, Git reminded the user of a new version on Windows. We should add a paragraph about that.
Poster

I never got such a reminder. But I don't use Git directly either... I'll check next time there's a new version and edit as necessary.

I never got such a reminder. But I don't use Git directly either... I'll check next time there's a new version and edit as necessary.
lhinderberger marked this conversation as resolved
Instructions will be added soon!
## Git clients
Git can be used with command lines as shown above, but it can also be used through so-called *Git clients*. A list (sample?) of them can be found on the [Git website](https://git-scm.com/downloads/guis).

Suggested wording changes:

  • "Git can be used with command lines" -> "Git can be used from the command line"
  • insert "graphical user interfaces, " between "through" and "so-called"
  • Drop (sample?)
  • "A list of them" -> "A list of some of them"
Suggested wording changes: - "Git can be used with command lines" -> "Git can be used from the command line" - insert "graphical user interfaces, " between "through" and "so-called" - Drop (sample?) - "A list of them" -> "A list of some of them"

Thinking about it, it'd be better to move the last link, like this, to avoid confusion between the git website and the GUI list on the git website.

"On the git website, you can find a list of some of them)."

Thinking about it, it'd be better to move the last link, like this, to avoid confusion between the git website and the GUI list on the git website. "On the git website, you can find [a list of some of them](https://git-scm.com/downloads/guis))."
lhinderberger marked this conversation as resolved

I suggest we pull this into an install-git branch after revision by Ivan and add instructions for Linux and OSX there (by the way, does someone of us use OSX? Because we'd need to find someone who could write that part.)

I suggest we pull this into an `install-git` branch after revision by Ivan and add instructions for Linux and OSX there (by the way, does someone of us use OSX? Because we'd need to find someone who could write that part.)
lhinderberger added the
Kind: Documentation
Status: Needs feedback
labels 2 years ago
Poster

Thank you very much for all the comments! I have edited accordingly. Feel free to comment again!

I do have a macOS computer at home so I might be able to write that part. But that computer lacks many of the dependencies necessary to make it work so it might be quite involved; and I don't have much free time when at home...

Thank you very much for all the comments! I have edited accordingly. Feel free to comment again! I do have a macOS computer at home so I might be able to write that part. But that computer lacks many of the dependencies necessary to make it work so it might be quite involved; and I don't have much free time when at home...
n commented 2 years ago
Collaborator

On macOS I think there are 3 main ways to install Git:

  • Xcode app (bundled together)
  • Xcode command line tools: xcode-select --install
  • Brew package manager: brew install git

I will verify and can add the instructions for macOS and Linux as well.

On macOS I think there are 3 main ways to install Git: - Xcode app (bundled together) - Xcode command line tools: `xcode-select --install` - Brew package manager: `brew install git` I will verify and can add the instructions for macOS and Linux as well.
lhinderberger approved these changes 2 years ago
lhinderberger left a comment

Thank you for the article - great work! :)

With the now provided edits, I will now merge this into the install-git branch of Codeberg Documentation, for @n to be able to add the install instructions for Linux/Unix/OSX.

Thank you for the article - great work! :) With the now provided edits, I will now merge this into the `install-git` branch of Codeberg Documentation, for @n to be able to add the install instructions for Linux/Unix/OSX.
lhinderberger changed target branch from master to install-git 2 years ago
lhinderberger changed title from WIP: Install Git Win10 to Install Git Win10 2 years ago
Codeberg-e.V. merged commit eb623b1be1 into install-git manually 2 years ago

Reviewers

lhinderberger approved these changes 2 years ago
The pull request has been manually merged as eb623b1be1.
Sign in to join this conversation.
No reviewers
No Milestone
No Assignees
3 Participants
Notifications
Due Date

No due date set.

Dependencies

This pull request currently doesn't have any dependencies.

Loading…
There is no content yet.