diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2017-08-25 15:20:53 +0000 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2017-08-25 15:20:53 +0000 |
| commit | 32fa51102bfa6b6fc1f4a6b9d1a8fb3be004ad71 (patch) | |
| tree | 50510c49ac11128d496e57ec759313e6aeec4f9a | |
| parent | 98cac5a5127d6a650d72bda38f3c77768eb412f3 (diff) | |
| parent | ffca8c1c3794d1e51ffee1c52c55c57c1e53c621 (diff) | |
| download | gitlab-ce-32fa51102bfa6b6fc1f4a6b9d1a8fb3be004ad71.tar.gz | |
Merge branch 'docs-update-links-guideline' into 'master'
Docs update links guideline to inline links
Closes gitlab-com/gitlab-docs#121
See merge request !13677
| -rw-r--r-- | doc/development/doc_styleguide.md | 13 | ||||
| -rw-r--r-- | doc/user/index.md | 7 |
2 files changed, 13 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 diff --git a/doc/user/index.md b/doc/user/index.md index e9ec603f2f1..f239a15d441 100644 --- a/doc/user/index.md +++ b/doc/user/index.md @@ -119,6 +119,13 @@ When performing inline reviews to implementations to your codebase through merge requests you can gather feedback through [resolvable discussions](discussions/index.md#resolvable-discussions). +### GitLab Flavored Markdown (GFM) + +Read through the [GFM documentation](markdown.md) to learn how to apply +the best of GitLab Flavored Markdown in your discussions, comments, +issues and merge requests descriptions, and everywhere else GMF is +supported. + ## Todos Never forget to reply to your collaborators. [GitLab Todos](../workflow/todos.md) |