diff options
| author | Evan Read <eread@gitlab.com> | 2019-03-01 19:07:47 +0000 |
|---|---|---|
| committer | Marcia Ramos <marcia@gitlab.com> | 2019-03-01 19:07:47 +0000 |
| commit | 2ee23bb3124588f3de5c25dbc6b5539ab66881f9 (patch) | |
| tree | e9ebeb6599bb243877b6cfd483167a4f708a0ef5 | |
| parent | adf71cfa75fb07c54cb2f55126d1f8596e3ab5c3 (diff) | |
| download | gitlab-ce-2ee23bb3124588f3de5c25dbc6b5539ab66881f9.tar.gz | |
Add confidential issue linking guidance
| -rw-r--r-- | doc/development/documentation/styleguide.md | 18 | ||||
| -rw-r--r-- | doc/development/i18n/merging_translations.md | 3 |
2 files changed, 19 insertions, 2 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 7a3a8f25c2d..cd38721e3ab 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -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. diff --git a/doc/development/i18n/merging_translations.md b/doc/development/i18n/merging_translations.md index 2fa7558d30b..85284d8c714 100644 --- a/doc/development/i18n/merging_translations.md +++ b/doc/development/i18n/merging_translations.md @@ -32,8 +32,7 @@ clicking `Pause sync` on the [Crowdin integration settings page](https://translate.gitlab.com/project/gitlab-ee/settings#integration). When all failures are resolved, the translations need to be double -checked once more [as discussed in this -issue](https://gitlab.com/gitlab-org/gitlab-ce/issues/37850). +checked once more as discussed in [confidential issue](https://docs.gitlab.com/ee/user/project/issues/confidential_issues.html) `https://gitlab.com/gitlab-org/gitlab-ce/issues/37850`. ## Merging translations |