Merge branch 'docs-ce-node-mdl-poc' into 'master'

Prepare the docs project for markdownlint

See merge request gitlab-org/gitlab-ce!31960

.mdlrc.style

@@ -18,7 +18,7 @@ rule "MD025"
 rule "MD028"
 rule "MD029", :style => :one
 rule "MD030"
-rule "MD032"
+# rule "MD032"
 rule "MD034"
 rule "MD037"
 rule "MD038"

doc/administration/instance_review.md

@@ -14,4 +14,3 @@ Additionally you will be contacted by our team for further review which should h
 
 [6995]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6995
 [ee]: https://about.gitlab.com/pricing/
-

doc/administration/job_artifacts.md

@@ -115,7 +115,7 @@ The connection settings match those provided by [Fog](https://github.com/fog), a
 | `aws_access_key_id` | AWS credentials, or compatible | |
 | `aws_secret_access_key` | AWS credentials, or compatible | |
 | `aws_signature_version` | AWS signature version to use. 2 or 4 are valid options. Digital Ocean Spaces and other providers may need 2. | 4 |
-| `enable_signature_v4_streaming` | Set to true to enable HTTP chunked transfers with AWS v4 signatures (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html). Oracle Cloud S3 needs this to be false | true
+| `enable_signature_v4_streaming` | Set to true to enable HTTP chunked transfers with [AWS v4 signatures](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html). Oracle Cloud S3 needs this to be false | true |
 | `region` | AWS region | us-east-1 |
 | `host` | S3 compatible host for when not using AWS, e.g. `localhost` or `storage.example.com` | s3.amazonaws.com |
 | `endpoint` | Can be used when configuring an S3 compatible service such as [Minio](https://www.minio.io), by entering a URL such as `http://127.0.0.1:9000` | (optional) |

doc/administration/merge_request_diffs.md

@@ -90,7 +90,7 @@ The connection settings match those provided by [Fog](https://github.com/fog), a
 | `aws_access_key_id` | AWS credentials, or compatible | |
 | `aws_secret_access_key` | AWS credentials, or compatible | |
 | `aws_signature_version` | AWS signature version to use. 2 or 4 are valid options. Digital Ocean Spaces and other providers may need 2. | 4 |
-| `enable_signature_v4_streaming` | Set to true to enable HTTP chunked transfers with AWS v4 signatures (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html). Oracle Cloud S3 needs this to be false | true
+| `enable_signature_v4_streaming` | Set to true to enable HTTP chunked transfers with [AWS v4 signatures](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html). Oracle Cloud S3 needs this to be false | true |
 | `region` | AWS region | us-east-1 |
 | `host` | S3 compatible host for when not using AWS, e.g. `localhost` or `storage.example.com` | s3.amazonaws.com |
 | `endpoint` | Can be used when configuring an S3 compatible service such as [Minio](https://www.minio.io), by entering a URL such as `http://127.0.0.1:9000` | (optional) |

doc/administration/reply_by_email_postfix_setup.md

@@ -331,7 +331,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
       a logout
       ```
 
-## Done!
+## Done
 
 If all the tests were successful, Postfix is all set up and ready to receive email! Continue with the [incoming email] guide to configure GitLab.
 

doc/administration/uploads.md

@@ -78,7 +78,7 @@ The connection settings match those provided by [Fog](https://github.com/fog), a
 | `aws_access_key_id` | AWS credentials, or compatible | |
 | `aws_secret_access_key` | AWS credentials, or compatible | |
 | `aws_signature_version` | AWS signature version to use. 2 or 4 are valid options. Digital Ocean Spaces and other providers may need 2. | 4 |
-| `enable_signature_v4_streaming` | Set to true to enable HTTP chunked transfers with AWS v4 signatures (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html). Oracle Cloud S3 needs this to be false | true
+| `enable_signature_v4_streaming` | Set to true to enable HTTP chunked transfers with [AWS v4 signatures](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html). Oracle Cloud S3 needs this to be false | true |
 | `region` | AWS region | us-east-1 |
 | `host` | S3 compatible host for when not using AWS, e.g. `localhost` or `storage.example.com` | s3.amazonaws.com |
 | `endpoint` | Can be used when configuring an S3 compatible service such as [Minio](https://www.minio.io), by entering a URL such as `http://127.0.0.1:9000` | (optional) |

doc/api/README.md

@@ -157,8 +157,8 @@ for example, without needing to explicitly pass an access token.
 With a few API endpoints you can use a [GitLab CI job token](../user/project/new_ci_build_permissions_model.md#job-token)
 to authenticate with the API:
 
-* [Get job artifacts](jobs.md#get-job-artifacts)
-* [Pipeline triggers](pipeline_triggers.md)
+- [Get job artifacts](jobs.md#get-job-artifacts)
+- [Pipeline triggers](pipeline_triggers.md)
 
 ### Impersonation tokens
 

doc/api/deploy_keys.md

@@ -203,6 +203,7 @@ Example response:
    "created_at" : "2015-08-29T12:44:31.550Z"
 }
 ```
+
 ## Adding deploy keys to multiple projects
 
 If you want to easily add the same deploy key to multiple projects in the same

doc/api/protected_branches.md

@@ -185,6 +185,7 @@ Example response:
     {
       "access_level": 30,
       "access_level_description": "Developers + Maintainers"
+    }
   ],
   "unprotect_access_levels": [
     {
@@ -217,6 +218,7 @@ Example response:
       "user_id": null,
       "group_id": null,
       "access_level_description": "Developers + Maintainers"
+    }
   ],
   "unprotect_access_levels": [
     {
@@ -232,7 +234,7 @@ Example response:
 ### Example with user / group level access **(STARTER)**
 
 Elements in the `allowed_to_push` / `allowed_to_merge` / `allowed_to_unprotect` array should take the
-form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md#restricting-push-and-merge-access-to-certain-users-starter) and were [added to the API in ][ee-3516] in GitLab 10.3 EE.
+form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md#restricting-push-and-merge-access-to-certain-users-starter) and were [added to the API in](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/3516) in GitLab 10.3 EE.
 
 ```bash
 curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&allowed_to_push%5B%5D%5Buser_id%5D=1'
@@ -242,29 +244,29 @@ Example response:
 
 ```json
 {
-  "name":"*-stable",
+  "name": "*-stable",
   "push_access_levels": [
     {
-      "access_level":null,
-      "user_id":1,
-      "group_id":null,
-      "access_level_description":"Administrator"
+      "access_level": null,
+      "user_id": 1,
+      "group_id": null,
+      "access_level_description": "Administrator"
     }
   ],
   "merge_access_levels": [
     {
-      "access_level":40,
-      "user_id":null,
-      "group_id":null,
-      "access_level_description":"Maintainers"
+      "access_level": 40,
+      "user_id": null,
+      "group_id": null,
+      "access_level_description": "Maintainers"
     }
   ],
   "unprotect_access_levels": [
     {
-      "access_level":40,
-      "user_id":null,
-      "group_id":null,
-      "access_level_description":"Maintainers"
+      "access_level": 40,
+      "user_id": null,
+      "group_id": null,
+      "access_level_description": "Maintainers"
     }
   ]
 }
@@ -286,5 +288,3 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" 'https://git
 | --------- | ---- | -------- | ----------- |
 | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
 | `name` | string | yes | The name of the branch |
-
-[ee-3516]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/3516 "ProtectedBranches API handles per user/group granularity"

doc/development/README.md

@@ -5,7 +5,7 @@ description: 'Learn how to contribute to GitLab.'
 
 # Contributor and Development Docs
 
-## Get started!
+## Get started
 
 - Set up GitLab's development environment with [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/README.md)
 - [GitLab contributing guide](contributing/index.md)

doc/development/api_styleguide.md

@@ -51,7 +51,7 @@ allowed.
 
 – <https://github.com/ruby-grape/grape#declared>
 
-### Exclude params from parent namespaces!
+### Exclude params from parent namespaces
 
 > By default `declared(params)`includes parameters that were defined in all
 parent namespaces.
@@ -64,7 +64,7 @@ In most cases you will want to exclude params from the parent namespaces:
 declared(params, include_parent_namespaces: false)
 ```
 
-### When to use `declared(params)`?
+### When to use `declared(params)`
 
 You should always use `declared(params)` when you pass the params hash as
 arguments to a method call.

doc/development/distributed_tracing.md

@@ -179,4 +179,3 @@ By default, the Jaeger search UI is available at <http://localhost:16686/search>
 TIP: **Tip:**
 Don't forget that you will need to generate traces by using the application before
 they appear in the Jaeger UI.
-

doc/development/ee_features.md

@@ -945,7 +945,7 @@ export default {
 - Since we [can't async load a mixin](https://github.com/vuejs/vue-loader/issues/418#issuecomment-254032223) we will use the [`ee_else_ce`](../development/ee_features.md#javascript-code-in-assetsjavascripts) alias we already have for webpack.
   - This means all the EE specific props, computed properties, methods, etc that are EE only should be in a mixin in the `ee/` folder and we need to create a CE counterpart of the mixin
 
-##### Example:
+##### Example
 
 ```javascript
 import mixin from 'ee_else_ce/path/mixin';
@@ -976,7 +976,7 @@ For regular JS files, the approach is similar.
    1. An EE file should be created with the EE only code, and it should extend the CE counterpart.
    1. For code inside functions that can't be extended, the code should be moved into a new file and we should use `ee_else_ce` helper:
 
-#### Example:
+#### Example
 
 ```javascript
   import eeCode from 'ee_else_ce/ee_code';

doc/development/rake_tasks.md

@@ -216,4 +216,3 @@ bundle exec rake routes
 
 Since these take some time to create, it's often helpful to save the output to
 a file for quick reference.
-

doc/install/installation.md

@@ -789,7 +789,7 @@ nginx: configuration file /etc/nginx/nginx.conf test failed`
 sudo service nginx restart
 ```
 
-## Done!
+## Post-install
 
 ### Double-check Application Status
 

doc/integration/oauth2_generic.md

@@ -12,7 +12,7 @@ This strategy is designed to allow configuration of the simple OmniAuth SSO proc
 1. Strategy parses user information from the response, using a **configurable** format
 1. GitLab finds or creates the returned user and logs them in
 
-## Limitations of this Strategy:
+## Limitations of this Strategy
 
 - It can only be used for Single Sign on, and will not provide any other access granted by any OAuth provider
   (importing projects or users, etc)

doc/migrate_ci_to_ce/README.md

@@ -227,7 +227,7 @@ sudo mv /path/to/12345_gitlab_ci_backup.tar /var/opt/gitlab/backups/
 sudo mv /path/to/12345_gitlab_ci_backup.tar /home/git/gitlab/tmp/backups/
 ```
 
-### 5. Import the CI data into GitLab.
+### 5. Import the CI data into GitLab
 
 This step will delete any existing CI data on your GitLab server. There should
 be no CI data yet because you turned CI on the GitLab server off earlier.

doc/public_access/public_access.md

@@ -6,7 +6,7 @@ type: reference
 
 GitLab allows [Owners](../user/permissions.md) to set a projects' visibility as **public**, **internal**
 or **private**. These visibility levels affect who can see the project in the
-public access directory (`/public` under your GitLab instance), like at [https://gitlab.com/public]().
+public access directory (`/public` under your GitLab instance), like at <https://gitlab.com/public>
 
 ## Visibility of projects
 

doc/raketasks/backup_restore.md

@@ -978,4 +978,3 @@ If this happens, check the following:
 
 1. Confirm there is sufficent diskspace for the gzip operation.
 1. If NFS is being used, check if the mount option `timeo` is set. The default is `600`, and changing this to smaller values have resulted in this error.
-

doc/raketasks/cleanup.md

 # Cleanup
 
-## Remove garbage from filesystem. Important! Data loss!
+## Remove garbage from filesystem
+
+DANGER: **Danger:**
+The commands below will remove data permanently from your GitLab instance. Only use
+these commands if you are 100% certain that it is safe to delete this data.
 
 Remove namespaces(dirs) from all repository storage paths if they don't exist in GitLab database.
 

doc/raketasks/import.md

@@ -11,7 +11,7 @@
 
 ## How to use
 
-### Create a new folder to import your Git repositories from.
+### Create a new folder to import your Git repositories from
 
 The new folder needs to have git user ownership and read/write/execute access for git user and its group:
 
@@ -19,7 +19,7 @@ The new folder needs to have git user ownership and read/write/execute access fo
 sudo -u git mkdir -p /var/opt/gitlab/git-data/repository-import-<date>/new_group
 ```
 
-### Copy your bare repositories inside this newly created folder:
+### Copy your bare repositories inside this newly created folder
 
 - Any .git repositories found on any of the subfolders will be imported as projects
 - Groups will be created as needed, these could be nested folders. Example:
@@ -38,7 +38,7 @@ sudo chown -R git:git /var/opt/gitlab/git-data/repository-import-<date>
 
 If you are using an installation from source, replace `/var/opt/gitlab/` with `/home/git`.
 
-### Run the command below depending on your type of installation:
+### Run the command below depending on your type of installation
 
 #### Omnibus Installation
 

doc/raketasks/web_hooks.md

 # Webhooks administration **(CORE ONLY)**
 
-## Add a webhook for **ALL** projects:
+## Add a webhook for **ALL** projects
 
 ```sh
 # omnibus-gitlab
@@ -9,7 +9,7 @@ sudo gitlab-rake gitlab:web_hook:add URL="http://example.com/hook"
 bundle exec rake gitlab:web_hook:add URL="http://example.com/hook" RAILS_ENV=production
 ```
 
-## Add a webhook for projects in a given **NAMESPACE**:
+## Add a webhook for projects in a given **NAMESPACE**
 
 ```sh
 # omnibus-gitlab
@@ -18,7 +18,7 @@ sudo gitlab-rake gitlab:web_hook:add URL="http://example.com/hook" NAMESPACE=acm
 bundle exec rake gitlab:web_hook:add URL="http://example.com/hook" NAMESPACE=acme RAILS_ENV=production
 ```
 
-## Remove a webhook from **ALL** projects using:
+## Remove a webhook from **ALL** projects using
 
 ```sh
 # omnibus-gitlab
@@ -27,7 +27,7 @@ sudo gitlab-rake gitlab:web_hook:rm URL="http://example.com/hook"
 bundle exec rake gitlab:web_hook:rm URL="http://example.com/hook" RAILS_ENV=production
 ```
 
-## Remove a webhook from projects in a given **NAMESPACE**:
+## Remove a webhook from projects in a given **NAMESPACE**
 
 ```sh
 # omnibus-gitlab
@@ -36,7 +36,7 @@ sudo gitlab-rake gitlab:web_hook:rm URL="http://example.com/hook" NAMESPACE=acme
 bundle exec rake gitlab:web_hook:rm URL="http://example.com/hook" NAMESPACE=acme RAILS_ENV=production
 ```
 
-## List **ALL** webhooks:
+## List **ALL** webhooks
 
 ```sh
 # omnibus-gitlab
@@ -45,7 +45,7 @@ sudo gitlab-rake gitlab:web_hook:list
 bundle exec rake gitlab:web_hook:list RAILS_ENV=production
 ```
 
-## List the webhooks from projects in a given **NAMESPACE**:
+## List the webhooks from projects in a given **NAMESPACE**
 
 ```sh
 # omnibus-gitlab

doc/security/rate_limits.md

@@ -30,4 +30,3 @@ similarly mitigated by a rate limit.
 This method of rate limiting is cumbersome, but has some advantages. It allows
 throttling of specific paths, and is also integrated into Git and container
 registry requests. See [Rack Attack initializer](rack_attack.md).
-

doc/university/README.md

@@ -57,7 +57,7 @@ The GitLab University curriculum is composed of GitLab videos, screencasts, pres
 1. [Migrating from SVN](../user/project/import/svn.md)
 1. [Migrating from Fogbugz](../user/project/import/fogbugz.md)
 
-### 1.6. GitLab Inc.
+### 1.6. The GitLab team
 
 1. [About GitLab](https://about.gitlab.com/about/)
 1. [GitLab Direction](https://about.gitlab.com/direction/)

doc/update/patch_versions.md

@@ -41,7 +41,7 @@ sudo -u git -H git checkout -- Gemfile.lock db/schema.rb locale
 sudo -u git -H git checkout LATEST_TAG -b LATEST_TAG
 ```
 
-### 3. Install libs, migrations, etc.
+### 3. Install libs, migrations, etc
 
 ```bash
 cd /home/git/gitlab

doc/update/upgrading_from_ce_to_ee.md

@@ -54,7 +54,7 @@ sudo -u git -H git remote add -f ee https://gitlab.com/gitlab-org/gitlab-ee.git
 sudo -u git -H git checkout EE_BRANCH
 ```
 
-### 3. Install libs, migrations, etc.
+### 3. Install libs, migrations, etc
 
 ```sh
 cd /home/git/gitlab

doc/update/upgrading_from_source.md

@@ -313,7 +313,7 @@ For Ubuntu 16.04.1 LTS:
 sudo systemctl daemon-reload
 ```
 
-### 13. Install libs, migrations, etc.
+### 13. Install libs, migrations, etc
 
 ```bash
 cd /home/git/gitlab

doc/user/markdown.md

@@ -57,12 +57,6 @@ render incorrectly:
   - milk
 ```
 
-1. Chocolate
-  - dark
-  - milk
-
----
-
 Simply add a space to each nested item to align the `-` with the first character of
 the top list item (`C` in this case):
 
@@ -265,8 +259,7 @@ this font installed by default.
 
 ### Front matter
 
-> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/23331)
-  in GitLab 11.6.
+> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/23331) in GitLab 11.6.
 
 Front matter is metadata included at the beginning of a markdown document, preceding
 its content. This data can be used by static site generators such as [Jekyll](https://jekyllrb.com/docs/front-matter/),
@@ -866,18 +859,6 @@ or underscores
 ___
 ```
 
-Three or more hyphens,
-
----
-
-asterisks,
-
-***
-
-or underscores
-
-___
-
 ### Images
 
 Examples:

doc/workflow/git_annex.md

@@ -200,7 +200,7 @@ searching for your distribution.
 Although there is no general guide for `git-annex` errors, there are a few tips
 on how to go around the warnings.
 
-### git-annex-shell: Not a git-annex or gcrypt repository.
+### git-annex-shell: Not a git-annex or gcrypt repository
 
 This warning can appear on the initial `git annex sync --content` and is caused
 by differences in `git-annex-shell`. You can read more about it