Automate guide versioning steps when creating a new release
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 36
- Forks
- 39
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 3
Description
We currently document our step-by-step process to create a new version of the documentation here: https://guide.wagtail.org/en-latest/contributing/#versioning
There are quite a few steps involved, and some take a lot of time: copying all images in particular. It would be nice to get some automation involved so this isn’t as time-consuming.
Link updates from the CMS we could automate:
- #306
Guide site updates we could automate:
- Bulk-copy images from the "latest" collection to a "vx.y.z" collection
- Bulk-update image references in copied pages from "latest" to their expected version / collection
Note all images for the latest release need updated visuals every 3 months anyway, so it might make sense to revisit this based on exact workflow.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the versioning process described at https://guide.wagtail.org/en-latest/contributing/#versioning and review the two unchecked guide-site steps. Determine how to bulk-copy images from the “latest” collection and update copied-page references to the release version; done means both operations are automated without relying on the manual process.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100