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
613168fa
Commit
613168fa
authored
Dec 31, 2018
by
Mike Lewis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Initial edits to intro
parent
1ca583ed
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
12 deletions
+8
-12
doc/development/documentation/structure.md
doc/development/documentation/structure.md
+8
-12
No files found.
doc/development/documentation/structure.md
View file @
613168fa
---
---
description
:
Learn the how to correctly structure GitLab documentation
.
description
:
What to include in GitLab documentation pages
.
---
---
# Documentation structure and template
# Documentation structure and template
For consistency throughout the documentation, it's important to maintain the same
This document will help you determine how to structure a page within GitLab's
structure among the docs.
documentation and what content to include. Following these standards helps
ensure consistency and completeness throughout the documentation, and makes it
easier to contribute.
Before getting started, read through the following docs:
Before getting started, familiarize yourself with
[
GitLab's Documentation guidelines
](
index.md
)
and the section on Content in the
[
Style Guide
](
styleguide.md
)
.
-
[
Contributing to GitLab documentation
](
index.md#contributing-to-docs
)
## Components of a documentation page
-
[
Merge requests for GitLab documentation
](
index.md#merge-requests-for-gitlab-documentation
)
-
[
Branch naming for docs-only changes
](
index.md#branch-naming
)
-
[
Documentation directory structure
](
index.md#documentation-directory-structure
)
-
[
Documentation style guidelines
](
styleguide.md
)
-
[
Documentation workflow
](
workflow.md
)
## Documentation blurb
Every document should include the following content in the following sequence:
Every document should include the following content in the following sequence:
...
...
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