From 03b152c5b9b24077f3c0b261052c93949127160f Mon Sep 17 00:00:00 2001 From: Marcel Amirault Date: Fri, 30 Aug 2019 03:29:45 +0000 Subject: [PATCH] Fix broken markdown in various docs --- doc/ci/caching/index.md | 2 +- doc/ci/yaml/README.md | 1 + doc/development/contributing/issue_workflow.md | 4 ++-- doc/topics/autodevops/index.md | 2 +- doc/user/application_security/security_dashboard/index.md | 2 +- 5 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/ci/caching/index.md b/doc/ci/caching/index.md index a59a0477b80..ab9fa517e23 100644 --- a/doc/ci/caching/index.md +++ b/doc/ci/caching/index.md @@ -175,7 +175,7 @@ job: ### Inherit global config, but override specific settings per job You can override cache settings without overwriting the global cache by using -[anchors](../yaml/README.md#anchors). For example, if you want to override the +[anchors](../yaml/README.md#anchors). For example, if you want to override the `policy` for one job: ```yaml diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 7a60dedc206..38276de6791 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -1989,6 +1989,7 @@ Marking a job to be run in parallel requires only a simple addition to your conf script: rspec + parallel: 5 ``` + TIP: **Tip:** Parallelize tests suites across parallel jobs. Different languages have different tools to facilitate this. diff --git a/doc/development/contributing/issue_workflow.md b/doc/development/contributing/issue_workflow.md index f00a810ec42..8b5d380ad9e 100644 --- a/doc/development/contributing/issue_workflow.md +++ b/doc/development/contributing/issue_workflow.md @@ -106,7 +106,7 @@ Stage labels specify which [stage](https://about.gitlab.com/handbook/product/cat Stage labels respects the `devops::` naming convention. `` is the stage key as it is in the single source of truth for stages at -with `_` replaced with ` `. +with `_` replaced with a space. For instance, the "Manage" stage is represented by the ~"devops::manage" label in the `gitlab-org` group since its key under `stages` is `manage`. @@ -132,7 +132,7 @@ Group labels respects the `group::` naming convention and their color is `#A8D695`. `` is the group key as it is in the single source of truth for groups at , -with `_` replaced with ` `. +with `_` replaced with a space. For instance, the "Continuous Integration" group is represented by the ~"group::continuous integration" label in the `gitlab-org` group since its key diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md index 1432147ca5b..15fdb52ac00 100644 --- a/doc/topics/autodevops/index.md +++ b/doc/topics/autodevops/index.md @@ -726,7 +726,7 @@ instead of the default `ruby:latest`: NOTE: **Note:** Passing in complex values (newlines and spaces, for example) will likely -cause escaping issues due to the way this argument is used in Auto DevOps. +cause escaping issues due to the way this argument is used in Auto DevOps. Consider using Base64 encoding of such values to avoid this problem. CAUTION: **Warning:** diff --git a/doc/user/application_security/security_dashboard/index.md b/doc/user/application_security/security_dashboard/index.md index 314f7c1766f..3d7f264c295 100644 --- a/doc/user/application_security/security_dashboard/index.md +++ b/doc/user/application_security/security_dashboard/index.md @@ -63,7 +63,7 @@ Once you're on the dashboard, at the top you should see a series of filters for: - Project NOTE: **Note:** -The dashboard only shows projects with [security reports](#supported-reports) enabled in a group. +The dashboard only shows projects with [security reports](#supported-reports) enabled in a group. ![dashboard with action buttons and metrics](img/group_security_dashboard.png) -- GitLab