Add confidential issue linking guidance
This commit is contained in:
parent
adf71cfa75
commit
2ee23bb312
2 changed files with 19 additions and 2 deletions
|
@ -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.
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
Loading…
Reference in a new issue