Add `charts/gitlab` to docs.gitlab.com
We need to make the charts a first class citizen for our docs. The GitLab chart is being worked on a different project, and as such we'd need to pull it in under a top level path: docs.gitlab.com/charts/
.
We need to clean up the charts content before adding it though. We also need to improve our main installation page, and other places that refer to installation options.
Epic with MVC actions &572 (closed)
Review app
http://add-charts-top-level.178.62.207.141.xip.io/charts/
Versions
Charts releases do not follow the same GitLab versions, so we need to think about that. Issue in the charts project https://gitlab.com/charts/gitlab/issues/1123.
Old description
We should add the `charts` group to docs.gitlab.com, as it will be much easier to manage documentation if we are able to do this. We do this today with `omnibus`, and this is really just another installation and packaging method.
The advantages:
- A single MR under review can contain both the code changes and documentation changes
- If you are developing in the repository, the documentation lives inside of it, rather than somewhere else which is confusing
- Maintaining docs in two places is unsustainable and will lead to errors
Challenges:
-
charts
is a group, not a single project. To improve maintainability, we have split each chart into its own project so it can have its own issue tracker, etc. - We will need to figure out a way to include a group inside the current docs structure.
Edited by Achilleas Pipinellis