diff options
| author | Mike Lewis <mlewis@gitlab.com> | 2018-12-31 22:40:06 +0300 |
|---|---|---|
| committer | Mike Lewis <mlewis@gitlab.com> | 2018-12-31 22:40:06 +0300 |
| commit | 66d4197edd60ae0b012e3c7003bdf8200bfdd36b (patch) | |
| tree | 17f459a114b614afa4fb42686d4f2224fcd80efa /doc | |
| parent | 2b76309b6c967917bded3480ac5d12609c329f79 (diff) | |
More minor edits
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/development/documentation/structure.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/development/documentation/structure.md b/doc/development/documentation/structure.md index f10b7205a86..ee3bd5606a5 100644 --- a/doc/development/documentation/structure.md +++ b/doc/development/documentation/structure.md @@ -14,9 +14,10 @@ and the section on Content in the [Style Guide](styleguide.md). ## Components of a documentation page Most pages will be dedicated to a specifig GitLab feature or to a use case that involves -one or more features and/or third-party tools. +one or more features, potentially in conjunction with third-party tools. -Every feature or use case document should include the following content in the following sequence: +Every feature or use case document should include the following content in the following sequence, +with exceptions and details noted below and in the template included on this page. - **Title**: Top-level heading with the feature name, or a use case name, which would start with a verb, like Configuring, Enabling, etc. |