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
Boxiang Sun
gitlab-ce
Commits
9982ff3f
Commit
9982ff3f
authored
Jul 25, 2018
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Prefer using direct links in docs styleguide
parent
83a64380
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
6 additions
and
8 deletions
+6
-8
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+6
-8
No files found.
doc/development/documentation/styleguide.md
View file @
9982ff3f
...
...
@@ -219,28 +219,26 @@ below.
-
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
n
ote:
blockqu
ote:
```md
> Introduced in GitLab 8.3.
```
-
Whenever possible, every feature should have a link to the
MR, issue, or epic that introduced it.
The above n
ote would be then transformed to:
-
Whenever possible, every feature should have a link to the
issue, MR or epic
(in that order) that introduced it. The above qu
ote would be then transformed to:
```md
> [Introduced]
[ce-1242]
in GitLab 8.3.
> [Introduced]
(https://gitlab.com/gitlab-org/gitlab-ce/issues/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 available in GitLab Enterprise Edition, don't forget to mention
the
[
paid tier
](
https://about.gitlab.com/handbook/marketing/product-marketing/#tiers
)
the feature is available in:
```md
> [Introduced][ee-1234] in [GitLab Starter](https://about.gitlab.com/pricing/) 8.3.
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/1242)
in [GitLab Starter](https://about.gitlab.com/pricing/) 8.3.
```
### Product badges
...
...
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