Somehow, tagging a release is creating "main" docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17.9k
- Forks
- 7.3k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 13
Description
📚 The doc issue
In #4687 I needed to change all the page's title and version. It seems tagging the version builds and uploads the docs to the gh-pages branch properly, but somehow the tag is not propagated into the doc build.
Also the last tag pushed generated docs/0.11. (with a '.' at the end) due to #4693. So that "proves" that the CIRCLECI_TAG is properly read in the CI, but something else is a bit off. So right now there are 0.11 docs and 0.11. docs, where the correct ones are 0.11.
I will try to figure out what is going on, and in any case immediately submit a PR to
- move the
0.11.docs on top of the0.11ones - replace all the version/title info with
0.11.0
@brianjo
Suggest a potential alternative/fix
No response
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 by reviewing the release documentation build and tagging flow, especially how CIRCLECI_TAG is passed into the gh-pages upload. Compare the docs/0.11 and docs/0.11. paths with the changes discussed in #4687 and #4693. Done means the tagged build produces one correctly versioned docs location and consistent title/version information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100