Commit 613168fa authored by Mike Lewis's avatar Mike Lewis

Initial edits to intro

parent 1ca583ed
--- ---
description: Learn the how to correctly structure GitLab documentation. description: What to include in GitLab documentation pages.
--- ---
# Documentation structure and template # Documentation structure and template
For consistency throughout the documentation, it's important to maintain the same This document will help you determine how to structure a page within GitLab's
structure among the docs. documentation and what content to include. Following these standards helps
ensure consistency and completeness throughout the documentation, and makes it
easier to contribute.
Before getting started, read through the following docs: Before getting started, familiarize yourself with [GitLab's Documentation guidelines](index.md)
and the section on Content in the [Style Guide](styleguide.md).
- [Contributing to GitLab documentation](index.md#contributing-to-docs) ## Components of a documentation page
- [Merge requests for GitLab documentation](index.md#merge-requests-for-gitlab-documentation)
- [Branch naming for docs-only changes](index.md#branch-naming)
- [Documentation directory structure](index.md#documentation-directory-structure)
- [Documentation style guidelines](styleguide.md)
- [Documentation workflow](workflow.md)
## Documentation blurb
Every document should include the following content in the following sequence: Every document should include the following content in the following sequence:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment