Merge branch 'docs/enforce-consistent-unordered-prefix' into 'master'

Enforce consistent prefix for bullet lists

See merge request !3391

doc/README.md

@@ -31,22 +31,22 @@ NOTE: **Note:**
 This section describes the commonly used configuration settings. Check
 [configuration](#configuring) section of the documentation for complete configuration settings.
 
-* [Installing GitLab](https://about.gitlab.com/installation/)
-  * [Manually downloading and installing a GitLab package](manual_install.md)
-* [Setting up a domain name/URL](https://docs.gitlab.com/omnibus/settings/configuration.html#configuring-the-external-url-for-gitlab) for the GitLab Instance so that it can be accessed easily
-* [Enabling HTTPS](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https)
-* [Enabling notification emails](https://docs.gitlab.com/omnibus/settings/smtp.html#smtp-settings)
-* [Enabling replying via email](https://docs.gitlab.com/ce/administration/reply_by_email.html#set-it-up)
-    * [Installing and configuring postfix](https://docs.gitlab.com/ce/administration/reply_by_email_postfix_setup.html)
-* [Enabling container registry on GitLab](https://docs.gitlab.com/ce/administration/container_registry.html#container-registry-domain-configuration)
-    * You will require SSL certificates for the domain used for container registry
-* [Enabling GitLab Pages](https://docs.gitlab.com/ce/administration/pages/)
-    * If you want HTTPS enabled, you will have to get wildcard certificates
-* [Enabling Elasticsearch](https://docs.gitlab.com/ee/integration/elasticsearch.html)
-* [GitLab Mattermost](gitlab-mattermost/README.md) Set up the Mattermost messaging app that ships with Omnibus GitLab package.
-* [GitLab Prometheus](https://docs.gitlab.com/ce/administration/monitoring/performance/prometheus.html) Set up the Prometheus
+- [Installing GitLab](https://about.gitlab.com/installation/)
+  - [Manually downloading and installing a GitLab package](manual_install.md)
+- [Setting up a domain name/URL](https://docs.gitlab.com/omnibus/settings/configuration.html#configuring-the-external-url-for-gitlab) for the GitLab Instance so that it can be accessed easily
+- [Enabling HTTPS](https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https)
+- [Enabling notification emails](https://docs.gitlab.com/omnibus/settings/smtp.html#smtp-settings)
+- [Enabling replying via email](https://docs.gitlab.com/ce/administration/reply_by_email.html#set-it-up)
+  - [Installing and configuring postfix](https://docs.gitlab.com/ce/administration/reply_by_email_postfix_setup.html)
+- [Enabling container registry on GitLab](https://docs.gitlab.com/ce/administration/container_registry.html#container-registry-domain-configuration)
+  - You will require SSL certificates for the domain used for container registry
+- [Enabling GitLab Pages](https://docs.gitlab.com/ce/administration/pages/)
+  - If you want HTTPS enabled, you will have to get wildcard certificates
+- [Enabling Elasticsearch](https://docs.gitlab.com/ee/integration/elasticsearch.html)
+- [GitLab Mattermost](gitlab-mattermost/README.md) Set up the Mattermost messaging app that ships with Omnibus GitLab package.
+- [GitLab Prometheus](https://docs.gitlab.com/ce/administration/monitoring/performance/prometheus.html) Set up the Prometheus
   monitoring included in the Omnibus GitLab package.
-* [GitLab High Availability Roles](roles/README.md)
+- [GitLab High Availability Roles](roles/README.md)
 
 #### Using docker image
 

doc/settings/nginx.md

@@ -466,7 +466,7 @@ This inserts the defined string into the end of the `server` block of
 
 ### Notes:
 
-+ If you're adding a new location, you might need to include
+- If you're adding a new location, you might need to include
 
     ```conf
     proxy_cache off;
@@ -476,7 +476,7 @@ This inserts the defined string into the end of the `server` block of
     in the string or in the included nginx config. Without these, any sub-location
     will return a 404. See
     [gitlab-ce#30619](https://gitlab.com/gitlab-org/gitlab-ce/issues/30619).
-+ You cannot add the root `/` location or the `/assets` location as those already
+- You cannot add the root `/` location or the `/assets` location as those already
     exist in `gitlab-http.conf`.
 
 ## Inserting custom settings into the NGINX config

doc/update/README.md

@@ -217,7 +217,6 @@ If you meet all the requirements above, follow these instructions in order. Ther
 | [Multi-node / HA](#multi-node--ha-deployment)| GitLab CE/EE on multiple nodes |
 | [Geo](#geo-deployment)                       | GitLab EE with Geo enabled     |
 
-
 ## Single deployment
 
 1. Create an empty file at `/etc/gitlab/skip-auto-reconfigure`. During software
@@ -259,16 +258,14 @@ If you meet all the requirements above, follow these instructions in order. Ther
     sudo gitlab-ctl hup sidekiq
     ```
 
-
 ## Multi-node / HA deployment
 
 Pick a node to be the `Deploy Node`.  It can be any node, but it must be the same
 node throughout the process.
 
-
 **Deploy node**
 
-* Create an empty file at `/etc/gitlab/skip-auto-reconfigure`. During software
+- Create an empty file at `/etc/gitlab/skip-auto-reconfigure`. During software
    installation only, this will prevent the upgrade from running
    `gitlab-ctl reconfigure` and automatically running database migrations
 
@@ -278,11 +275,11 @@ node throughout the process.
 
 **All other nodes (not the Deploy node)**
 
-* Ensure that `gitlab_rails['auto_migrate'] = false` is set in `/etc/gitlab/gitlab.rb`
+- Ensure that `gitlab_rails['auto_migrate'] = false` is set in `/etc/gitlab/gitlab.rb`
 
 **Deploy node**
 
-* Update the GitLab package
+- Update the GitLab package
 
     ```sh
     # Debian/Ubuntu
@@ -294,7 +291,7 @@ node throughout the process.
 
     If you are an Enterprise Edition user, replace `gitlab-ce` with `gitlab-ee` in the above command.
 
-* To get the regular database migrations in place, run
+- To get the regular database migrations in place, run
 
     ```sh
     SKIP_POST_DEPLOYMENT_MIGRATIONS=true sudo gitlab-ctl reconfigure
@@ -302,7 +299,7 @@ node throughout the process.
 
 **All other nodes (not the Deploy node)**
 
-* Update the GitLab package
+- Update the GitLab package
 
     ```sh
     sudo apt-get update && sudo apt-get install gitlab-ce
@@ -310,7 +307,7 @@ node throughout the process.
 
     If you are an Enterprise Edition user, replace `gitlab-ce` with `gitlab-ee` in the above command.
 
-* Ensure nodes are running the latest code
+- Ensure nodes are running the latest code
 
     ```sh
     sudo gitlab-ctl reconfigure
@@ -318,7 +315,7 @@ node throughout the process.
 
 **Deploy node**
 
-* Once all nodes are updated, run the following to run post-deployment database migrations
+- Once all nodes are updated, run the following to run post-deployment database migrations
 
     ```sh
     sudo gitlab-rake db:migrate
@@ -326,14 +323,13 @@ node throughout the process.
 
 **For nodes that run unicorn or sidekiq**
 
-* Hot reload `unicorn` and `sidekiq` services
+- Hot reload `unicorn` and `sidekiq` services
 
     ```sh
     sudo gitlab-ctl hup unicorn
     sudo gitlab-ctl hup sidekiq
     ```
 
-
 ## Geo deployment
 
 **Primary node**
@@ -393,7 +389,6 @@ On the Primary node, executing the following:
 
 **Secondary node(s)**
 
-
 NOTE: **Note:**
 Only proceed if you have successfully completed all steps on the Primary node.
 

gitlab-ci-config/gitlab-com.yml

@@ -129,7 +129,7 @@ docs-lint:
     # Lint Markdown
     # https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
     - bundle exec mdl content/omnibus/**/*.md --rules \
-        MD029,MD032,MD034
+        MD004,MD029,MD032,MD034
     # Build HTML from Markdown
     - bundle exec nanoc
     # Check the internal links