Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
Developer Documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
brienne
Developer Documentation
Commits
0a0ab2b4
Commit
0a0ab2b4
authored
8 years ago
by
Sean Madsen
Browse files
Options
Downloads
Patches
Plain Diff
Moving "content standards" that Sean proposed in Documentation page into the new Style Guide page
parent
85de74d3
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/best-practices/documentation-style-guide.md
+14
-4
14 additions, 4 deletions
docs/best-practices/documentation-style-guide.md
docs/documentation.md
+0
-24
0 additions, 24 deletions
docs/documentation.md
with
14 additions
and
28 deletions
docs/best-practices/documentation-style-guide.md
+
14
−
4
View file @
0a0ab2b4
...
@@ -14,8 +14,16 @@ Similar to most text books and manuals, we divide our guides into "parts",
...
@@ -14,8 +14,16 @@ Similar to most text books and manuals, we divide our guides into "parts",
-
"chapter" - file (in markdown), also one web page with a given URL
-
"chapter" - file (in markdown), also one web page with a given URL
-
"section" - heading within the page
-
"section" - heading within the page
Keep the page hierarchy to this depth (i.e. do not put folders within other
In the navigation menu: (as stored in
`mkdocs.yml`
)
folders).
-
Keep the page hierarchy to this depth (i.e. do not put folders within other
folders).
-
Each chapter name should be short enough to fit nicely in the menu,
but also long enough to stand on its own to a reasonable extent.
The titles set here are used in the navigation menu
*and*
the page title
that displays in the browser tab. The guide will be more usable if the
reader sees two tabs titled "Using Hooks" and "API Usage" instead of
"Usage" and "Usage".
Each chapter should start with a paragraph that explains what will be
Each chapter should start with a paragraph that explains what will be
covered in the chapter.
covered in the chapter.
...
@@ -31,8 +39,10 @@ in H2 and H3, only where necessary. If you find yourself wanting to use
...
@@ -31,8 +39,10 @@ in H2 and H3, only where necessary. If you find yourself wanting to use
H4, consider if it's truly necessary and whether the chapter should
H4, consider if it's truly necessary and whether the chapter should
instead be refactored.
instead be refactored.
Part titles and subheadings should be in sentence case (first word
### Capitalization
capitalized), not headline case (each word capitalized).
Titles for parts, chapters, and sections should all be in sentence case
(first word capitalized), not headline case (each word capitalized).
## Formatting conventions
## Formatting conventions
...
...
This diff is collapsed.
Click to expand it.
docs/documentation.md
+
0
−
24
View file @
0a0ab2b4
...
@@ -61,28 +61,4 @@ However, for a better editing experience we highly recommend installing
...
@@ -61,28 +61,4 @@ However, for a better editing experience we highly recommend installing
1.
When you are happy with your edits, use git to commit and push your changes.
1.
When you are happy with your edits, use git to commit and push your changes.
Then submit a pull request on GitHub.
Then submit a pull request on GitHub.
### Content standards for guides
These content standards apply to all guides written in MkDocs.
-
Keep it simple
-
Be concise.
-
When possible, avoid the use of: tables, deeply nested lists, and
images.
-
Page titles
-
*In navigation menu:*
(as stored in
`mkdocs.yml`
) should be short enough
to fit nicely in the menu, but should also long enough to stand on its
own to a reasonable extent. The titles set here are used in the
navigation menu
*and*
the page title that displays in the browser tab.
The guide will be more usable if the reader sees two tabs titled
"Using Hooks" and "API Usage" instead of "Usage" and "Usage".
-
*In page content:*
Insert one heading 1 at the top of each page. In the
rest of the page, use headings of level 2 and greater.
-
Navigation structure
-
Each page (except "Home") should be contained within one and only one
folder. The folder serves as a "part" and the page serves as a "chapter"
which is in keeping with the structure common to most text books and
manuals. Do not make deeper levels of page hierarchy.
[
Markdown
]:
markdownrules.md
[
Markdown
]:
markdownrules.md
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment