diff options
author | Sanad Liaquat <sliaquat@gitlab.com> | 2019-03-15 11:52:39 +0500 |
---|---|---|
committer | Sanad Liaquat <sliaquat@gitlab.com> | 2019-03-15 11:52:39 +0500 |
commit | e73f8713812b912b3b0244e99b6a18b9422a2d4d (patch) | |
tree | de67e0ab7931961752caeccef78f393365391f81 /doc/development/documentation/styleguide.md | |
parent | 82c0816d3fdd96412605845fa337b74b6a3534c4 (diff) | |
download | gitlab-ce-qa-artillery-io-script.tar.gz |
Add Load testing script for artillery.ioqa-artillery-io-script
Also add rake tasks that makes use of existing performance data
genertion task.
Diffstat (limited to 'doc/development/documentation/styleguide.md')
-rw-r--r-- | doc/development/documentation/styleguide.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index c0386290785..0c51d3832aa 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -80,10 +80,11 @@ yield a useful result, and ensuring content is helpful and easy to consume. ## Text -- Splitting long lines (preferably up to 100 characters) can make it easier to provide feedback on small chunks of text. -- Insert an empty line for new paragraphs. +- Split up long lines (wrap text), this makes it much easier to review and edit. Only + double line breaks are shown as a full line break by creating new paragraphs. + 80-100 characters is the recommended line length. - Use sentence case for titles, headings, labels, menu items, and buttons. -- Insert an empty line between different markups (e.g., after every paragraph, header, list, etc). Example: +- Jump a line between different markups (e.g., after every paragraph, header, list, etc). Example: ```md ## Header |