kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Move Content section to style guide

Browse source
This commit is contained in:
Mike Lewis 2018-12-31 02:40:00 +00:00
parent 10784261e7
commit c665b845e9
1 changed files with 0 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/development/documentation/improvement-workflow.md
View file

@ -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.