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
1
Merge Requests
1
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
nexedi
gitlab-ce
Commits
f97d8a8a
Commit
f97d8a8a
authored
Apr 06, 2020
by
Suzanne Selhorn
Committed by
Evan Read
Apr 06, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Docs style update to remove Overview heading
parent
e990cfc6
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
6 additions
and
6 deletions
+6
-6
doc/development/documentation/structure.md
doc/development/documentation/structure.md
+6
-6
No files found.
doc/development/documentation/structure.md
View file @
f97d8a8a
...
...
@@ -21,8 +21,10 @@ with exceptions and details noted below and in the template included on this pag
-
**Title**
: Top-level heading with the feature name, or a use case name, which would start with
a verb, like Configuring, Enabling, etc.
-
**Introduction**
: A couple sentences about the subject matter and what's to be found on this page.
-
**Overview**
Describe what it is, what it does, and in what context it should be used.
-
**Introduction**
: A couple sentences about the subject matter and what's to be found
on this page. Describe what the feature or topic is, what it does, and in what context it should
be used. There is no need to add a title called "Introduction" or "Overview," because people rarely
search for these terms. Just put this information after the title.
-
**Use cases**
: describes real use case scenarios for that feature/configuration.
-
**Requirements**
: describes what software, configuration, account, or knowledge is required.
-
**Instructions**
: One or more sets of detailed instructions to follow.
...
...
@@ -54,12 +56,10 @@ description: "Short document description." # Up to ~200 chars long. They will be
> [Introduced](link_to_issue_or_mr) in GitLab (Tier) X.Y (2).
An introduction -- without its own additional header -- goes here.
Offer a
very short
description of the feature or use case, and what to expect on this page.
Offer a description of the feature or use case, and what to expect on this page.
(You can reuse this content, or part of it, for the front matter's
`description`
at the top of this file).
## Overview
The feature overview should answer the following questions:
The introduction should answer the following questions:
-
What is this feature or use case?
-
Who is it for?
...
...
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