diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-23 03:09:21 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-23 03:09:21 +0000 |
commit | 5b51129e3356a12283f0ba2da15db897ee30cf1a (patch) | |
tree | 81aab0c51c265782c093da49f089908761d5426d /doc/development/documentation/index.md | |
parent | 71da67f3262eeffe59cc228986e0a2bb97b6dba5 (diff) | |
download | gitlab-ce-5b51129e3356a12283f0ba2da15db897ee30cf1a.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/index.md')
-rw-r--r-- | doc/development/documentation/index.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index 8300413a0a6..8897b61d6dc 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -58,7 +58,7 @@ However, anyone can contribute [documentation improvements](improvement-workflow ## Markdown and styles [GitLab docs](https://gitlab.com/gitlab-org/gitlab-docs) uses [GitLab Kramdown](https://gitlab.com/gitlab-org/gitlab_kramdown) -as its Markdown rendering engine. See the [GitLab Markdown Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/) for a complete Kramdown reference. +as its Markdown rendering engine. See the [GitLab Markdown Guide](https://about.gitlab.com/handbook/engineering/ux/technical-writing/markdown-guide/) for a complete Kramdown reference. Adhere to the [Documentation Style Guide](styleguide.md). If a style standard is missing, you are welcome to suggest one via a merge request. @@ -523,7 +523,7 @@ A file with `proselint` configuration must be placed in a [markdownlint](https://github.com/DavidAnson/markdownlint) checks that Markdown syntax follows [certain rules](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#rules), and is used by the [`docs-lint` test](#testing) with a [configuration file](#markdownlint-configuration). -Our [Documentation Style Guide](styleguide.md#markdown) and [Markdown Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/) +Our [Documentation Style Guide](styleguide.md#markdown) and [Markdown Guide](https://about.gitlab.com/handbook/engineering/ux/technical-writing/markdown-guide/) elaborate on which choices must be made when selecting Markdown syntax for GitLab documentation. This tool helps catch deviations from those guidelines. |