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
f95eebc7
Commit
f95eebc7
authored
Dec 29, 2018
by
Mike Lewis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Bring in 'content - what belongs in docs' from 'other' workflow page
parent
04e7b1cf
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
20 additions
and
2 deletions
+20
-2
doc/development/documentation/index.md
doc/development/documentation/index.md
+20
-2
No files found.
doc/development/documentation/index.md
View file @
f95eebc7
...
...
@@ -21,6 +21,24 @@ The source of the documentation is maintained in the following repository locati
Documentation issues and merge requests are part of their respective repositories and all have the label
`Documentation`
.
## Content: what belongs in the docs
In docs, we share any and all helpful information, processes, and tips with customers.
There is no reason to withhold 'risky' steps and store them in another
location; simply include them in the docs with all necessary detail including
sufficiently specific warnings and caveats.
Any content that is relevant to users, admins, or IT decision-makers may be included.
You can freely include presentations, videos, etc.; no matter who it was originally written for,
if it is helpful to any of our audiences, we can include it.
See the
[
Documentation Structure
](
structure.md
)
page for further details and a sample document template.
Note that a
`Troubleshooting`
section in doc pages is part of that default template
and can freely be added to any page.
These guidelines help toward the goal of having every user's search of documentation
yield a useful result.
## Contributing to docs
[
Contributions to GitLab docs
](
workflow.md
)
are welcome from the entire GitLab community:
...
...
@@ -227,7 +245,7 @@ This redirection method will not provide a redirect fallback on GitLab `/help`.
it, make sure to add a link to the new page on the doc, otherwise it's a dead end for users that
land on the doc via `/help`.
### Redirections for pages with Disqus comments
###
#
Redirections for pages with Disqus comments
If the documentation page being relocated already has any Disqus comments,
we need to preserve the Disqus thread.
...
...
@@ -265,7 +283,7 @@ choices:
| Ending in `-docs` | `123-update-api-issues-docs` |
If your branch name matches any of the above, it will run only the docs
tests. If it does
n't, the whole test suite will run (including doc
s).
tests. If it does
not, the whole application test suite will run (including docs test
s).
## Merge requests for GitLab documentation
...
...
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