Commit a8ae80ea authored by Katrin Leinweber's avatar Katrin Leinweber Committed by Achilleas Pipinellis

Fix typos & minor formatting inconsistency

parent 41f6db67
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
type: reference type: reference
--- ---
# .gitignore API # `.gitignore` API
In GitLab, there is an API endpoint available for `.gitignore`. For more In GitLab, there is an API endpoint available for `.gitignore`. For more
information on `gitignore`, see the information on `gitignore`, see the
......
...@@ -56,13 +56,13 @@ When declaring multiple globals, always use one `/* global [name] */` line per v ...@@ -56,13 +56,13 @@ When declaring multiple globals, always use one `/* global [name] */` line per v
## Formatting with Prettier ## Formatting with Prettier
Our code is automatically formatted with [Prettier](https://prettier.io) to follow our style guides. Prettier is taking care of formatting .js, .vue, and .scss files based on the standard prettier rules. You can find all settings for Prettier in `.prettierrc`. Our code is automatically formatted with [Prettier](https://prettier.io) to follow our style guides. Prettier is taking care of formatting `.js`, `.vue`, and `.scss` files based on the standard prettier rules. You can find all settings for Prettier in `.prettierrc`.
### Editor ### Editor
The easiest way to include prettier in your workflow is by setting up your preferred editor (all major editors are supported) accordingly. We suggest setting up prettier to run automatically when each file is saved. Find [here](https://prettier.io/docs/en/editors.html) the best way to set it up in your preferred editor. The easiest way to include prettier in your workflow is by setting up your preferred editor (all major editors are supported) accordingly. We suggest setting up prettier to run automatically when each file is saved. Find [here](https://prettier.io/docs/en/editors.html) the best way to set it up in your preferred editor.
Please take care that you only let Prettier format the same file types as the global Yarn script does (.js, .vue, and .scss). In VSCode by example you can easily exclude file formats in your settings file: Please take care that you only let Prettier format the same file types as the global Yarn script does (`.js`, `.vue`, and `.scss`). In VSCode by example you can easily exclude file formats in your settings file:
```json ```json
"prettier.disableLanguages": [ "prettier.disableLanguages": [
......
...@@ -22,7 +22,7 @@ To enable the Microsoft Azure OAuth2 OmniAuth provider you must register your ap ...@@ -22,7 +22,7 @@ To enable the Microsoft Azure OAuth2 OmniAuth provider you must register your ap
1. Add a "Reply URL" pointing to the Azure OAuth callback of your GitLab installation (e.g. `https://gitlab.mycompany.com/users/auth/azure_oauth2/callback`). 1. Add a "Reply URL" pointing to the Azure OAuth callback of your GitLab installation (e.g. `https://gitlab.mycompany.com/users/auth/azure_oauth2/callback`).
1. Create a "Client secret" by selecting a duration, the secret will be generated as soon as you click the "Save" button in the bottom menu.. 1. Create a "Client secret" by selecting a duration, the secret will be generated as soon as you click the "Save" button in the bottom menu.
1. Note the "CLIENT ID" and the "CLIENT SECRET". 1. Note the "CLIENT ID" and the "CLIENT SECRET".
......
...@@ -300,7 +300,7 @@ sudo -u git -H bundle exec rake gitlab:backup:create SKIP=tar RAILS_ENV=producti ...@@ -300,7 +300,7 @@ sudo -u git -H bundle exec rake gitlab:backup:create SKIP=tar RAILS_ENV=producti
#### Uploading backups to a remote (cloud) storage #### Uploading backups to a remote (cloud) storage
Starting with GitLab 7.4 you can let the backup script upload the '.tar' file it creates. Starting with GitLab 7.4 you can let the backup script upload the `.tar` file it creates.
It uses the [Fog library](http://fog.io/) to perform the upload. It uses the [Fog library](http://fog.io/) to perform the upload.
In the example below we use Amazon S3 for storage, but Fog also lets you use In the example below we use Amazon S3 for storage, but Fog also lets you use
[other storage providers](http://fog.io/storage/). GitLab [other storage providers](http://fog.io/storage/). GitLab
......
...@@ -253,7 +253,7 @@ If you need to utilize some code that was introduced in `master` after you creat ...@@ -253,7 +253,7 @@ If you need to utilize some code that was introduced in `master` after you creat
If your feature branch has a merge conflict, creating a merge commit is a standard way of solving this. If your feature branch has a merge conflict, creating a merge commit is a standard way of solving this.
NOTE: **Note:** NOTE: **Note:**
Sometimes you can use .gitattributes to reduce merge conflicts. Sometimes you can use `.gitattributes` to reduce merge conflicts.
For example, you can set your changelog file to use the [union merge driver](https://git-scm.com/docs/gitattributes#gitattributes-union) so that multiple new entries don't conflict with each other. For example, you can set your changelog file to use the [union merge driver](https://git-scm.com/docs/gitattributes#gitattributes-union) so that multiple new entries don't conflict with each other.
The last reason for creating merge commits is to keep long-running feature branches up-to-date with the latest state of the project. The last reason for creating merge commits is to keep long-running feature branches up-to-date with the latest state of the project.
......
...@@ -278,7 +278,7 @@ git rm '*.txt' ...@@ -278,7 +278,7 @@ git rm '*.txt'
git rm -r <dirname> git rm -r <dirname>
``` ```
If we want to remove a file from the repository but keep it on disk, say we forgot to add it to our .gitignore file then use `--cache`: If we want to remove a file from the repository but keep it on disk, say we forgot to add it to our `.gitignore` file then use `--cache`:
```shell ```shell
git rm <filename> --cache git rm <filename> --cache
......
...@@ -10,7 +10,7 @@ the previous version you were using. ...@@ -10,7 +10,7 @@ the previous version you were using.
First, roll back the code or package. For source installations this involves First, roll back the code or package. For source installations this involves
checking out the older version (branch or tag). For Omnibus installations this checking out the older version (branch or tag). For Omnibus installations this
means installing the older .deb or .rpm package. Then, restore from a backup. means installing the older `.deb` or `.rpm` package. Then, restore from a backup.
Follow the instructions in the Follow the instructions in the
[Backup and Restore](../raketasks/backup_restore.md#restore-gitlab) [Backup and Restore](../raketasks/backup_restore.md#restore-gitlab)
documentation. documentation.
......
...@@ -452,6 +452,6 @@ involve pinning to the previous template versions, for example: ...@@ -452,6 +452,6 @@ involve pinning to the previous template versions, for example:
``` ```
Additionally, we provide a dedicated project containing the versioned legacy templates. Additionally, we provide a dedicated project containing the versioned legacy templates.
This can be useful for offline setups or anyone wishing to use [Auto DevOps](../../topics/autodevops/index.md).. This can be useful for offline setups or anyone wishing to use [Auto DevOps](../../topics/autodevops/index.md).
Instructions are available in the [legacy template project](https://gitlab.com/gitlab-org/auto-devops-v12-10). Instructions are available in the [legacy template project](https://gitlab.com/gitlab-org/auto-devops-v12-10).
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment