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
Léo-Paul Géneau
gitlab-ce
Commits
66d4197e
Commit
66d4197e
authored
Dec 31, 2018
by
Mike Lewis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
More minor edits
parent
2b76309b
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
3 additions
and
2 deletions
+3
-2
doc/development/documentation/structure.md
doc/development/documentation/structure.md
+3
-2
No files found.
doc/development/documentation/structure.md
View file @
66d4197e
...
@@ -14,9 +14,10 @@ and the section on Content in the [Style Guide](styleguide.md).
...
@@ -14,9 +14,10 @@ and the section on Content in the [Style Guide](styleguide.md).
## Components of a documentation page
## Components of a documentation page
Most pages will be dedicated to a specifig GitLab feature or to a use case that involves
Most pages will be dedicated to a specifig GitLab feature or to a use case that involves
one or more features
and/or
third-party tools.
one or more features
, potentially in conjunction with
third-party tools.
Every feature or use case document should include the following content in the following sequence:
Every feature or use case document should include the following content in the following sequence,
with exceptions and details noted below and in the template included on this page.
-
**Title**
: Top-level heading with the feature name, or a use case name, which would start with
-
**Title**
: Top-level heading with the feature name, or a use case name, which would start with
a verb, like Configuring, Enabling, etc.
a verb, like Configuring, Enabling, etc.
...
...
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