2.8 KiB
2.8 KiB
| stage | group | info |
|---|---|---|
| none | unassigned | To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments |
Documentation site architecture
The gitlab-docs project hosts
the repository which is used to generate the GitLab documentation website and
is deployed to https://docs.gitlab.com. It uses the Nanoc
static site generator.
View the gitlab-docs architecture page
for more information.
Documentation in other repositories
If you have code and documentation in a repository other than the primary repositories, you should keep the documentation with the code in that repository.
Then you can use one of these approaches:
- Recommended. Add the repository to the list of products published at https://docs.gitlab.com. The source of the documentation pages remains in the external repository, but the resulting pages are indexed and searchable on https://docs.gitlab.com.
- Recommended. Add an entry in the global navigation for https://docs.gitlab.com that links directly to the documentation in that external repository. The documentation pages are not indexed or searchable on https://docs.gitlab.com. View an example.
- Create a landing page for the product in the
gitlabrepository, and add the landing page to the global navigation, but keep the rest of the documentation in the external repository. The landing page is indexed and searchable on https://docs.gitlab.com, but the rest of the documentation is not. For example, the GitLab Workflow extension for VS Code. We do not encourage the use of pages with lists of links, so only use this option if the recommended options are not feasible.
Monthly release process (versions)
The docs website supports versions and each month we add the latest one to the list. For more information, read about the monthly release process.
Review Apps for documentation merge requests
If you are contributing to GitLab docs read how to create a Review App with each merge request.