diff options
| author | Mike Lewis <mlewis@gitlab.com> | 2019-03-07 15:59:00 +0000 |
|---|---|---|
| committer | Mike Lewis <mlewis@gitlab.com> | 2019-03-07 15:59:00 +0000 |
| commit | dbd7309a16bd3abc6c586b6c2df2beb317cfef95 (patch) | |
| tree | 3fdd719c926ac80285f0dc93ef975625657d0fbb /doc/development/documentation/styleguide.md | |
| parent | 7be248334b350091e83d0335bf0c263071c6a67f (diff) | |
| parent | b63efb09a5c864047924cd2d84527b47dd563d5f (diff) | |
| download | gitlab-ce-reply-to-comment-documentation.tar.gz | |
Merge branch 'master' into 'reply-to-comment-documentation'reply-to-comment-documentation
# Conflicts:
# doc/user/discussions/index.md
Diffstat (limited to 'doc/development/documentation/styleguide.md')
| -rw-r--r-- | doc/development/documentation/styleguide.md | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 7a3a8f25c2d..0c51d3832aa 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -36,7 +36,7 @@ gem will support all [GFM markup](../../user/markdown.md) in the future. For now use regular markdown markup, following the rules on this style guide. For a complete Kramdown reference, check the [GitLab Markdown Kramdown Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/). Use Kramdown markup wisely: do not overuse its specific markup (e.g., `{:.class}`) as it will not render properly in -[`/help`](#gitlab-help). +[`/help`](index.md#gitlab-help). ## Content @@ -236,6 +236,24 @@ For other punctuation rules, please refer to the E.g., instead of writing something like `Read more about GitLab Issue Boards [here](LINK)`, write `Read more about [GitLab Issue Boards](LINK)`. +### Links to confidential issues + +Don't link directly to [confidential issues](../../user/project/issues/confidential_issues.md). These will fail for: + +- Those without sufficient permissions. +- Automated link checkers. + +Instead: + +- Mention in the text that the information is contained in a confidential issue. This will reduce confusion. +- Provide a link in back ticks (`` ` ``) so that those with access to the issue can easily navigate to it. + +Example: + +```md +For more information, see the [confidential issue](https://docs.gitlab.com/ee/user/project/issues/confidential_issues.html) `https://gitlab.com/gitlab-org/gitlab-ce/issues/<issue_number>`. +``` + ### Unlinking emails By default, all email addresses will render in an email tag on docs.gitlab.com. @@ -612,7 +630,7 @@ In this case: - The code blocks are indented one or more spaces under the list item to render correctly. - Different highlighting languages are used for each config in the code block. -- The [references](#references) guide is used for reconfigure/restart. +- The [GitLab Restart](#gitlab-restart) section is used to explain a required restart/reconfigure of GitLab. ## API |