Criteria for adding a new product to the docs site
The docs site is created by pulling down documentation from four different repositories as you can see from the architecture documentation https://docs.gitlab.com/ee/development/documentation/site_architecture/#architecture.
As time goes by, more and more "secondary" GitLab projects pop up, that the authors (engineers, PMs, etc.) ask us how to get them under docs.gitlab.com. This issue is about that. We need to establish a process for adding new products to the docs site. What criteria should a project have in order to get it under the docs site?
Limitations/drawbacks
- Versions: Is the new product versioned the same as GitLab? If not, there's need to be some hacking to get it to work. Charts falls into this category for example.
- We can only use full URLs to link between content in different repos.
- There's potential fragmentation and unnecessary cross-linking for things that are in other repos.
- Even though this is not yet implemented, we would not be able to use tabbed content in the future.
Requirements
- Vale/Markdownlint implemented in the project's pipeline with same rules as main project
- A TW assigned to the group that is the DRI for the project's docs, and actively reviews submissions to the docs
- Versioning
- File names use underscores
Edited by Achilleas Pipinellis