Commit de277167 authored by Francisco-Javier Ramon Salguero's avatar Francisco-Javier Ramon Salguero
Browse files

Configuration section extended

parent b36ac75d
Loading
Loading
Loading
Loading
+14 −2
Original line number Diff line number Diff line
@@ -21,6 +21,7 @@ Basic Software (available on Windows, Mac. and Linux):

- [Git](https://git-scm.com/)
- [Pandoc](https://pandoc.org/)
  - In Windows, you might want to install MiKTeX in addition to support conversion to PDF.
- Markdown editor(s). Recommended (both):
  - Integrated: [Visual Studio Code](https://code.visualstudio.com/)
    - The integrated editor supports version control operations graphically, so that usual operations do not require CLI commands necessarily.
@@ -91,7 +92,18 @@ git config --global user.name "myEOLusername"
git config --global user.email "myusername@mycompany.com"
```

It is also highly advisable adding an SSH key to https://osm.etsi.org/gitlab/profile/keys so that password is not requested in every operation.
If you want to check if Git configuration was successfully enforced, you can do:

```bash
git config --list
```

| NOTE  |
|---|
| Your email address will be visible on commits to Git. |
| If wanted to keep your email address private, you can mask your `user.email` but it is highly advisable to preserve your company name. E.g.  Instead of `myuser@company.com`, you can set it to `hidden@company.com` |

It is also highly advisable adding an SSH key to [your profile keys](https://osm.etsi.org/gitlab/profile/keys) so that password is not requested anymore.

## Guide for contributors

@@ -103,7 +115,7 @@ It is also highly advisable adding an SSH key to https://osm.etsi.org/gitlab/pro
git clone ssh://git@osm.etsi.org:29419/osm-doc/test.git
```

**>>>>> TEMPORARY URL**:
In some cases (e.g. in presence of firewalls blocking the SSH port), you can use as fallback option the HTTPS access:

```bash
git clone https://osm.etsi.org/gitlab/osm-doc/test.git