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
c665b845
Commit
c665b845
authored
Dec 31, 2018
by
Mike Lewis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Move Content section to style guide
parent
10784261
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
0 additions
and
18 deletions
+0
-18
doc/development/documentation/improvement-workflow.md
doc/development/documentation/improvement-workflow.md
+0
-18
No files found.
doc/development/documentation/improvement-workflow.md
View file @
c665b845
...
...
@@ -21,24 +21,6 @@ DevOps workflows.
Follow GitLab's
[
Merge Request Guidelines
](
../contributing/merge_request_workflow.md#merge-request-guidelines
)
.
## Content: what belongs in the docs
In docs, we share any and all helpful info/processes/tips with customers, but
warn them in specific terms about the potential ramifications of any mentioned
actions. There is no reason to withhold 'risky' steps and store them in another
location; simply include them along with the rest of the docs, with all necessary
detail including specific warnings and caveats.
Any content that is relevant to users or admins 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.
A
`Troubleshooting`
section in doc pages is part of the default
[
template
](
structure.md
)
for a new page, 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.
## Merging
Anyone with master access to the affected GitLab project can merge documentation changes.
...
...
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