kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Merge branch 'notes_guidelines' into 'master'

Browse source 
Change doc styleguide to use blockquotes for notes



See merge request !3009
This commit is contained in:
Achilleas Pipinellis 2016-03-02 08:00:33 +00:00
commit 07bc0b43b0
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/development/doc_styleguide.md
View file

@ -85,9 +85,19 @@ Inside the document:
## Notes
- Notes should be in italics with the word `Note:` being bold. Use this form:
`_**Note:** This is something to note._`. If the note spans across multiple
lines it's OK to split the line.
- Notes should be quoted with the word `Note:` being bold. Use this form:
```
>**Note:**
This is something to note.
```
which renders to:
>**Note:**
This is something to note.
If the note spans across multiple lines it's OK to split the line.
## New features