summaryrefslogtreecommitdiff
path: root/doc/development/documentation
diff options
context:
space:
mode:
authorEvan Read <eread@gitlab.com>2019-04-29 09:33:08 +0000
committerMarcia Ramos <marcia@gitlab.com>2019-04-29 09:33:08 +0000
commitc135061ff9eb353f239bc1a9d49f1b4584940a66 (patch)
treeb2915748f525a99c321eece386d54014b27d37c7 /doc/development/documentation
parent7d29dbe49d78359dcafdd52c7ce61c980b2262ae (diff)
downloadgitlab-ce-c135061ff9eb353f239bc1a9d49f1b4584940a66.tar.gz
Avoid links requiring permissions
Diffstat (limited to 'doc/development/documentation')
-rw-r--r--doc/development/documentation/styleguide.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md
index fbca99fbfea..9d8d5afedad 100644
--- a/doc/development/documentation/styleguide.md
+++ b/doc/development/documentation/styleguide.md
@@ -362,16 +362,23 @@ 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
+### Links requiring permissions
-Don't link directly to [confidential issues](../../user/project/issues/confidential_issues.md). These will fail for:
+Don't link directly to:
+
+- [Confidential issues](../../user/project/issues/confidential_issues.md).
+- Project features that require [special permissions](../../user/permissions.md) to view.
+
+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.
+- To reduce confusion, mention in the text that the information is either:
+ - Contained in a confidential issue.
+ - Requires special permission to a project to view.
- Provide a link in back ticks (`` ` ``) so that those with access to the issue can easily navigate to it.
Example: