Skip to content
Snippets Groups Projects
Commit 9bdd5b72 authored by Heather McNamee's avatar Heather McNamee
Browse files

add more GitLab specific recommendations

parent 30684452
No related branches found
No related tags found
No related merge requests found
Loading
Loading
@@ -106,14 +106,18 @@ See references directly in the documentation style guide. Of particular use:
- [Formatting text][docformatting]
- [Links in text][doclinks]
 
Code blocks should be formatted with a line space before the code block and
three back ticks before and after the code block
Always put filenames in backticks ` so they appear as code inline. For example: `filenames`
A sentence leading up to an explanatory codeblock should end in a colon instead of a period.
Before and after code blocks: include a full line break and three back ticks.
There is no need to indent the code block.
 
<pre>
 
```
code
```
```
code
```
</pre>
 
Loading
Loading
@@ -181,6 +185,10 @@ For example don't refer to "Gitlab CI's runner" please refer to "GitLab Runner."
 
We refer to **GitLab team members** instead of staff.
 
Make sure we always call it `.gitlab-ci.yml`, with the leading period and backticks.
When we refer to specific configuration sections or pages in GitLab they should be in Bold.
************
 
Credit where credit is due: Some of the guidelines are inspired by the
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment