Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
iv
gitlab-ce
Commits
e5b974bd
Commit
e5b974bd
authored
Jun 13, 2016
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Plain Diff
Merge branch 'fix-notes-doc-styleguide' into 'master'
Change to new Notes styleguide See merge request !4625
parents
c0e415e4
cb7fa10c
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
5 additions
and
5 deletions
+5
-5
doc/development/doc_styleguide.md
doc/development/doc_styleguide.md
+5
-5
No files found.
doc/development/doc_styleguide.md
View file @
e5b974bd
...
...
@@ -103,14 +103,14 @@ Inside the document:
-
Every piece of documentation that comes with a new feature should declare the
GitLab version that feature got introduced. Right below the heading add a
note:
`
_**Note:** This feature was introduced in GitLab 8.3_
`
note:
`
>**Note:** This feature was introduced in GitLab 8.3
`
-
If possible every feature should have a link to the MR that introduced it.
The above note would be then transformed to:
`
_**Note:** This feature was [introduced][ce-1242] in GitLab 8.3_
`
, where
`
>**Note:** This feature was [introduced][ce-1242] in GitLab 8.3
`
, where
the
[
link identifier
](
#links
)
is named after the repository (CE) and the MR
number
-
If the feature is only in GitLab EE, don't forget to mention it, like:
`
_**Note:** This feature was introduced in GitLab EE 8.3_
`
. Otherwise, leave
`
>**Note:** This feature was introduced in GitLab EE 8.3
`
. Otherwise, leave
this mention out
## References
...
...
@@ -222,8 +222,8 @@ curl --data "name=foo" -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.
#### Post data using JSON content
_
**Note:** In this example we create a new group. Watch carefully the single
and double quotes.
_
>
**Note:** In this example we create a new group. Watch carefully the single
and double quotes.
```bash
curl -X POST -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" -H "Content-Type: application/json" --data '{"path": "my-group", "name": "My group"}' https://gitlab.example.com/api/v3/groups
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment