diff options
author | Mike Lewis <mlewis@gitlab.com> | 2018-12-31 02:40:00 +0000 |
---|---|---|
committer | Mike Lewis <mlewis@gitlab.com> | 2018-12-31 02:40:00 +0000 |
commit | c665b845e9b285056eb841ab267bc04d73dfa917 (patch) | |
tree | d03acd8ecb30ca5fad99fd2b8f6e762750f85bca /doc/development/documentation/improvement-workflow.md | |
parent | 10784261e7d03a53a7a6cd0e2cca5380540221e8 (diff) | |
download | gitlab-ce-c665b845e9b285056eb841ab267bc04d73dfa917.tar.gz |
Move Content section to style guide
Diffstat (limited to 'doc/development/documentation/improvement-workflow.md')
-rw-r--r-- | doc/development/documentation/improvement-workflow.md | 18 |
1 files changed, 0 insertions, 18 deletions
diff --git a/doc/development/documentation/improvement-workflow.md b/doc/development/documentation/improvement-workflow.md index cc8f60c27c7..5d4d2b6f7bb 100644 --- a/doc/development/documentation/improvement-workflow.md +++ b/doc/development/documentation/improvement-workflow.md @@ -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. |