This instance will be upgraded to Heptapod 0.31.0 (final) on 2022-05-24 at 14:00 UTC+2 (a few minutes of down time)

Commit d9f4dfe9 authored by Job van der Voort's avatar Job van der Voort
Browse files

Merge branch 'master' into 'master'

Added documentation styleguide

Hi. I added a documentation styleguide and linked it to

See merge request !709
......@@ -163,6 +163,7 @@ If you add a dependency in GitLab (such as an operating system package) please c
1. [Shell commands](doc/development/ created by GitLab contributors to enhance security
1. [Markdown](
1. [Database Migrations](doc/development/
1. [Documentation styleguide](
1. Interface text should be written subjectively instead of objectively. It should be the gitlab core team addressing a person. It should be written in present time and never use past tense (has been/was). For example instead of "prohibited this user from being saved due to the following errors:" the text should be "sorry, we could not create your account because:". Also these [excellent writing guidelines](
This is also the style used by linting tools such as [RuboCop](, [PullReview]( and [Hound CI](
# Documentation styleguide
This styleguide recommends best practices to improve documentation and to keep it organized and easy to find.
## Text
* Make sure that the documentation is added in the correct directory and that there's a link to it somewhere useful.
* Add only one H1 or title in each document, by adding '#' at the begining of it (when using markdown). For subtitles, use '##', '###' and so on.
* Do not duplicate information.
* Be brief and clear.
## When adding images to a document
* Create a directory to store the images with the specific name of the document where the images belong. It could be in the same directory where the .md document that you're working on is located.
* Images should have a specific, non-generic name that will differentiate them.
* Keep all file names in lower case.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment