summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2017-08-18 16:44:28 -0300
committerMarcia Ramos <virtua.creative@gmail.com>2017-08-18 16:44:28 -0300
commit43dea824c1a0d0306714d691bb88ce3490adcae6 (patch)
tree8ce3578db6e6692a7d4d9582aebf374e3e74db98
parent11661c2a1dfe042f37e3ba1eac69315daa0edb9b (diff)
downloadgitlab-ce-43dea824c1a0d0306714d691bb88ce3490adcae6.tar.gz
use inline links instead of referenced
-rw-r--r--doc/development/doc_styleguide.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md
index 90d1d9657b9..798f40eef3d 100644
--- a/doc/development/doc_styleguide.md
+++ b/doc/development/doc_styleguide.md
@@ -113,13 +113,12 @@ merge request.
## Links
-- If a link makes the paragraph to span across multiple lines, do not use
- the regular Markdown approach: `[Text](https://example.com)`. Instead use
- `[Text][identifier]` and at the very bottom of the document add:
- `[identifier]: https://example.com`. This is another way to create Markdown
- links which keeps the document clear and concise. Bonus points if you also
- add an alternative text: `[identifier]: https://example.com "Alternative text"`
- that appears when hovering your mouse on a link
+- Use the regular inline link markdown markup `[Text](https://example.com)`.
+ It's easier to read, review, and maintain.
+- If there's a link that repeats several times through the same document,
+ you can use `[Text][identifier]` and at the bottom of the section or the
+ document add: `[identifier]: https://example.com`, in which case, we do
+ encourage you to also add an alternative text: `[identifier]: https://example.com "Alternative text"` that appears when hovering your mouse on a link.
### Linking to inline docs