Skip to content

Provide alternative ZIP file for hosthing the docs site locally

Split from #390 (closed)

We already produce a Docker image for each help version, however, to make the files more accessible, we can offer a simple ZIP file in parallel.

Requirements:

  • Establish place to host these zip files (S3 buckets)
  • Generate the compressed file on each doc site build
  • Offer basic instructions on the availability of these files and the paths to match on your server e.g. gitlabdocs.yourdomain.com/12.0 vs 12.1
  • Have an Engineering Productivity team engineer test the process.

We can create a workflow like:

  1. With each version (Docker build and upload to Registry), create an artifact that will be hosted to a GCP bucket (S3).
  2. Create a tag for the specific version and use the releases API to list the artifact in the release page (Release user docs).

Limitations:

  1. Releases rely on tags and we're using branches. Tags are immutable, so if we ever need to update a Docker image by pulling the latest changes of the version branch, we'd need to nuke the tag and recreate it.