Add versions
Update
Closing this in favor of an epic gitlab-com&8 (closed)
This will be necessary for replacing the Help section of the Rails app (https://gitlab.com/gitlab-org/gitlab-ce/issues/18739).
Decisions:
- Version-less URL should built from
master
-
master
is deployed under/
- Show comments only for version-less URL
Infrastructure and site building
Inspired from how Docker does versioning https://github.com/docker/docker.github.io/tree/publish-tools.
-
Create onbuild Docker images -
Create branches in the docs site that match each release -
Create separate Dockerfile
s for each branch with the versions it should pull from -
Create an archive Docker image every month containing all previous versions https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/199 -
Create an archives page with links to the archives and Docker images https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/199 -
Make sure CE is not included in the menu for stable and master branches (the compile_prod
job makes sure of this) -
Use a backup registry, prob on dev (enable mirror pushing) #179 (closed) -
Use custom Docker image when rolled to production https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/232 -
Create a detailed readme for all the tooling
Backend
-
The "Edit on GitLab.com" filter will need to be updated (use only on the master branches) -
Handle robots.txt
to exclude the versioned pages -
Handle the sitemap.xml
for each version
Frontend
-
Create a dropdown with the versions gitlab-com/gitlab-docs#180 -
Have a banner at the top if you're not on the latest version and a dropdown to choose the version https://gitlab.com/gitlab-com/gitlab-docs/issues/181
Search
-
Edit Algolia's config to include search results for versions https://gitlab.com/gitlab-com/gitlab-docs/issues/182
Extras
-
Minify and compress assets https://gitlab.com/gitlab-com/gitlab-docs/issues/183
Test locally
You'll need Docker installed, then run:
docker run -it --rm -p 4000:4000 registry.gitlab.com/gitlab-com/gitlab-docs:latest
Edited by Achilleas Pipinellis