The following page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features or functionality remain at the sole discretion of GitLab Inc.
| Stage | Ecosystem |
| Maturity | N/A |
| Content Last Reviewed | 2022-06-20 |
| Maintained by | Susan Tacker |
Our goal is to create documentation that is complete, accurate, and easy to use. It should be easy to browse or search for the information you need, and easy to contribute to the documentation itself. All standards and practices for contributing documentation are found in the GitLab Documentation guidelines section of the docs site.
GitLab documentation is designed to help you with all of your DevOps needs. The source is stored along with product code in repositories in GitLab. The primary repositories are:
Installation documentation comes from these repositories:
The documentation is published, by version, at docs.gitlab.com. The documentation is also included in each version of the product and is visible by selecting the ? icon in the top right corner of the navigation bar.
GitLab Users: GitLab administrators and users rely on accurate, up-to-date, and comprehensive documentation of available features.
GitLab Team Members: GitLab team members are both contributors to and consumers of the documentation. While the Technical Writing team owns the documentation, anyone can and does contribute to the docs.
Leadership and Decision-makers: The GitLab documentation site is a valuable resource for decision-makers to compare features across versions and evaluate implementation details that may impact a purchasing decision.
A recent round of UX research highlighted a few key opportunities for improving the GitLab documentation site:
/help and docs.gitlab.com are different sites and different experiences.Other problems not noted by research, such as a lack of context-sensitive Help, are also addressed in the Documentation Roadmap.
Our current focus is on improving the /help experience, improving the search function on the docs site, and defining guidelines for context-sensitive Help.
As outlined in the Documentation Roadmap and in quarterly OKRs, a number of improvements are prioritized to address the challenges listed above.
In addition, we're planning to invest in versioning improvements.
At this time, we are not investigating any significant architectural changes to the documentation site itself, like migrating to a new static site generator.
The Technical Writing team is not currently investing in localization of the documentation.
Currently, the GitLab Documentation Site category is a non-marketing category, which means its maturity does not get tracked.