Contributing to Documentation

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

Documentation

GitLab welcomes contributions to the product documentation.

If you need an issue to work on

View the documentation issues curated specifically for new contributors.

From the list, select an issue you'd like to work on.

• If the issue is already assigned to someone, pick a different one.

• If the issue is unassigned, add a comment and ask to work on the issue.

  For a Hackathon, use @docs-hackathon. Otherwise, use @gl-docsteam. For example:

  @docs-hackathon I would like to work on this issue
  

• Do not ask for more than three issues at a time.

After the issue is assigned to you, open a merge request to address it. If you've never contributed to the GitLab documentation before, view instructions for how to do it.

If you want to explore on your own

If you don't find an open issue to work on, you can still update the documentation.

Go to https://docs.gitlab.com and at the bottom of any page, select View page source or Edit in Web IDE.

You can also:

• Choose a page in the /doc directory and edit it from there.
• Try installing and running the Vale linting tool and fixing the resulting issues.

If you're updating docs as part of code development

When you're developing code, the workflow for updating docs is slightly different.

For details, see the Contributing to Development page.