Contributing to Documentation

1. You are here:
2. Community
3. Contribute to GitLab
4. Contributing to Documentation

Documentation

This section pertains to documentation changes that are independent of other code or feature changes. For documentation changes that accompany changes to code or features, see the Contributing to Development page.

See the Documentation Style Guide and Writing Documentation pages for more important details on writing documentation for GitLab.

1. Visit docs.gitlab.com for the latest documentation on GitLab, Charts, Omnibus, Runner and others.
2. Find a page that’s lacking important information or that has a spelling/grammar mistake. NOTE: Gitlab uses US English.
3. Click the “Edit this page” link at the bottom of the page, fork the relevant project, and modify the documentation in GitLab’s web editor. Alternatively, you can fork the relevant project locally and edit the corresponding file(s) in its /doc or /docs path.
4. Open a merge request and remember to follow branch naming conventions if you forked the project locally.
5. Mention @gl-docsteam in a comment, then wait for a review. You may need to change things if a reviewer requests it.
6. Get your changes merged!