Update documentation for self-hosting product docs
Issue Description
Related to: Q4FY2022 KR: Determine how to improve/remedy th... (#509 - closed)
The goal of this issue is the following item from the roadmap for improving the common documentation experience for self-managed and SaaS customers:
Update product documentation to better support installing and updating your own local product documentation site.
Refine the information at https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/help_page/self_host.md. Ensure the “self-hosting your docs” links are integrated into the installation instructions for self-managed GitLab installations. Ensure directions to update your self-hosted docs are included in any update instructions for self-managed GitLab installations.
Questions
- Does the documentation need to reside where it currently is? Should it be moved over into the main GitLab repo?
Needed items
We have 4 installation methods, we may want to link from each one of them:
- Docker: we can directly link to https://docs.gitlab.com/ee/administration/docs_self_host.html#self-host-the-product-documentation-with-docker
- https://about.gitlab.com/install/: could be in the next steps
- Cloud native: here we have charts (and soon the Operator), could mention here https://docs.gitlab.com/charts/installation/deployment.html
- Source: we could link under the advanced tips, or create a new section that will point to the next steps doc.
For upgrade we have about the same amount of docs.
Deliverable
One or more completed MRs that involve integrating "how to set up and maintain a self-hosted GitLab Docs site" into the GitLab product documentation. This includes moving the content from the gitlab docs repo to the gitlab repo, adding it to the global nav, setting up redirects, updating the content based on style and IA guidelines, and updating existing installation and upgrade docs to refer to setting up a self-hosted Docs site.