summaryrefslogtreecommitdiff
path: root/doc/development/documentation
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-03-17 15:09:10 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-03-17 15:09:10 +0000
commit8e129497b2565b8c595ef4f806d9a9595ca654e5 (patch)
tree7afeeca3ea58013c1e8c3a2055661bacf65577da /doc/development/documentation
parent8ae26d705abe341b03bc15d4373d6cd0c77c0baf (diff)
downloadgitlab-ce-8e129497b2565b8c595ef4f806d9a9595ca654e5.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation')
-rw-r--r--doc/development/documentation/index.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md
index 694acc16a97..8300413a0a6 100644
--- a/doc/development/documentation/index.md
+++ b/doc/development/documentation/index.md
@@ -8,7 +8,7 @@ GitLab's documentation is [intended as the single source of truth (SSOT)](https:
In addition to this page, the following resources can help you craft and contribute documentation:
-- [Style Guide](styleguide.md) - What belongs in the docs, language guidelines, Markdown standards to follow, and more.
+- [Style Guide](styleguide.md) - What belongs in the docs, language guidelines, Markdown standards to follow, links, and more.
- [Structure and template](structure.md) - Learn the typical parts of a doc page and how to write each one.
- [Documentation process](workflow.md).
- [Markdown Guide](../../user/markdown.md) - A reference for all Markdown syntax supported by GitLab.
@@ -116,8 +116,9 @@ Things to note:
- The above `git grep` command will search recursively in the directory you run
it in for `workflow/lfs/lfs_administration` and `lfs/lfs_administration`
and will print the file and the line where this file is mentioned.
- You may ask why the two greps. Since we use relative paths to link to
- documentation, sometimes it might be useful to search a path deeper.
+ You may ask why the two greps. Since [we use relative paths to link to
+ documentation](styleguide.md#links)
+ , sometimes it might be useful to search a path deeper.
- The `*.md` extension is not used when a document is linked to GitLab's
built-in help page, that's why we omit it in `git grep`.
- Use the checklist on the "Change documentation location" MR description template.