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
9dc01030
Commit
9dc01030
authored
Jan 30, 2020
by
Mike Jang
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Include guidance on header titles
parent
9d61654f
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
15 additions
and
5 deletions
+15
-5
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+13
-3
doc/development/documentation/workflow.md
doc/development/documentation/workflow.md
+1
-1
scripts/lint-doc.sh
scripts/lint-doc.sh
+1
-1
No files found.
doc/development/documentation/styleguide.md
View file @
9dc01030
...
@@ -175,7 +175,7 @@ The table below shows what kind of documentation goes where.
...
@@ -175,7 +175,7 @@ The table below shows what kind of documentation goes where.
|
`doc/update/`
| Contains instructions for updating GitLab. |
|
`doc/update/`
| Contains instructions for updating GitLab. |
|
`doc/topics/`
| Indexes per topic (
`doc/topics/topic-name/index.md`
): all resources for that topic. |
|
`doc/topics/`
| Indexes per topic (
`doc/topics/topic-name/index.md`
): all resources for that topic. |
### Work
ing
with directories and files
### Work with directories and files
1.
When you create a new directory, always start with an
`index.md`
file.
1.
When you create a new directory, always start with an
`index.md`
file.
Do not use another file name and
**do not**
create
`README.md`
files.
Do not use another file name and
**do not**
create
`README.md`
files.
...
@@ -530,6 +530,16 @@ For other punctuation rules, please refer to the
...
@@ -530,6 +530,16 @@ For other punctuation rules, please refer to the
document. For example,
`## Examples`
is a bad heading;
`## GitLab Pages examples`
document. For example,
`## Examples`
is a bad heading;
`## GitLab Pages examples`
is a better one. It's not an exact science, but please consider this carefully.
is a better one. It's not an exact science, but please consider this carefully.
### Heading titles
Keep heading titles clear and direct. Make every word count. To accommodate search engine optimization (SEO), use the imperative, where possible.
| Do | Don't |
|:-----|:--------|
| Configure GDK | Configuring GDK |
| GitLab Release and Maintenance Policy | This section covers GitLab's Release and Maintenance Policy |
| Backport to older releases | Backporting to older releases |
### Anchor links
### Anchor links
Headings generate anchor links automatically when rendered.
`## This is an example`
Headings generate anchor links automatically when rendered.
`## This is an example`
...
@@ -828,7 +838,7 @@ Usage examples:
...
@@ -828,7 +838,7 @@ Usage examples:
[
Bootstrap utility class
](
https://getbootstrap.com/docs/4.4/utilities/float/
)
:
[
Bootstrap utility class
](
https://getbootstrap.com/docs/4.4/utilities/float/
)
:
`**{tanuki, 32, float-right}**`
renders as:
**{tanuki, 32, float-right}**
`**{tanuki, 32, float-right}**`
renders as:
**{tanuki, 32, float-right}**
### Us
ing
GitLab SVGs to describe UI elements
### Us
e
GitLab SVGs to describe UI elements
When using GitLab SVGs to describe screen elements, also include the name or tooltip of the element as text.
When using GitLab SVGs to describe screen elements, also include the name or tooltip of the element as text.
...
@@ -1003,7 +1013,7 @@ Examples:
...
@@ -1003,7 +1013,7 @@ Examples:
-
"Open a merge request to fix a broken link".
-
"Open a merge request to fix a broken link".
-
"After you open a merge request (MR), submit your MR for review and approval".
-
"After you open a merge request (MR), submit your MR for review and approval".
### Describ
ing
UI elements
### Describ
e
UI elements
The following are styles to follow when describing UI elements on a screen:
The following are styles to follow when describing UI elements on a screen:
...
...
doc/development/documentation/workflow.md
View file @
9dc01030
...
@@ -382,7 +382,7 @@ Ensure the following if skipping an initial Technical Writer review:
...
@@ -382,7 +382,7 @@ Ensure the following if skipping an initial Technical Writer review:
-
Specific
[
user permissions
](
../../user/permissions.md
)
are documented.
-
Specific
[
user permissions
](
../../user/permissions.md
)
are documented.
-
That new documents are linked from higher-level indexes, for discoverability.
-
That new documents are linked from higher-level indexes, for discoverability.
-
Style guide is followed:
-
Style guide is followed:
-
For
[
directories and files
](
styleguide.md#work
ing
-with-directories-and-files
)
.
-
For
[
directories and files
](
styleguide.md#work-with-directories-and-files
)
.
-
For
[
images
](
styleguide.md#images
)
.
-
For
[
images
](
styleguide.md#images
)
.
NOTE:
**Note:**
NOTE:
**Note:**
...
...
scripts/lint-doc.sh
View file @
9dc01030
...
@@ -43,7 +43,7 @@ if [ ${FIND_READMES} -ne $NUMBER_READMES ]
...
@@ -43,7 +43,7 @@ if [ ${FIND_READMES} -ne $NUMBER_READMES ]
then
then
echo
echo
echo
' ✖ ERROR: New README.md file(s) detected, prefer index.md over README.md.'
>
&2
echo
' ✖ ERROR: New README.md file(s) detected, prefer index.md over README.md.'
>
&2
echo
' https://docs.gitlab.com/ee/development/documentation/styleguide.html#work
ing
-with-directories-and-files'
echo
' https://docs.gitlab.com/ee/development/documentation/styleguide.html#work-with-directories-and-files'
echo
echo
exit
1
exit
1
fi
fi
...
...
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