[meta] Refactor Pages docs
Our Pages docs are very complete, we have a lot of good content there. But it needs to be reorganized to make it onboarding Pages easier and simpler.
Index: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/15411
-
Refactor Pages index: our Pages index was the first one we created, and it's confusing the way it was structured. Let's begin with something really simple (minimum requirements and steps), then gather additional info afterward. -
The first how-to blog post about it is also redundant now that we have our user guides. Mention that the process is outdated/deprecated. -
The Let's Encrypt post is outdated, mention that on the index. -
Add a brief description of each link -
Leave informative posts to the end (Pages IP, Pages coming to CE, etc)
Other docs:
-
Our content in the intro guide has duplicated/redundant information. We need to clear it up to contain only technical aspects of GL Pages that are not mentioned in other docs (redirects, custom 404, limitations, repo and artifacts size, branching, etc): https://gitlab.com/gitlab-org/gitlab-ce/issues/58178 -
Update according to new feature (11.8): project templates for Pages: https://gitlab.com/gitlab-org/gitlab-ce/issues/58033 -
The StartSSL post is deprecated. Bring the info about the importance of HTTPS into a new doc, and not even mention this post in the index anymore => https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/16837 -
Check every mention of navigating to project settings and update them according to the new UI => https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17188 Maybe remove the DNS part from the Pages guide to a generic doc, per https://gitlab.com/gitlab-org/gitlab-ce/issues/39748#note_46327302-
Check the 2nd part guide for missing links -
Make it clearer that we need the site content to live in the public/
directory (per https://gitlab.com/gitlab-org/gitlab-ce/issues/40686) => https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17188 -
Improve the "Getting started" section for this feedback from the community: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/5071, https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/5503, https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/18629 -
Explain how to set up www
CNAME records toexample.com
(https://gitlab.com/gitlab-org/gitlab-ce/issues/47585) => https://gitlab.com/gitlab-org/gitlab-ce/issues/48848 => https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/21259 -
Clarify that users of GitLab self-hosted instances need to set up a completely new wildcard domain for Pages (https://gitlab.com/gitlab-org/gitlab-ce/issues/31961#note_79728739 => https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/20369)
Notes from Sid/Job: => https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17188
Choose your SSG template => from where? Fork a project from the Pages group => how do I fork? Remove the fork relationship by navigating to your Project's Settings > Edit Project => I spend 5 minutes to find this Enable Shared Runners for your fork: navigate to your Project's Settings > Pipelines => outdated
Edited by Marcia Ramos