Creating versioning for LTS versions of API, Python Client
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 71
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 11
Description
Add versioning to rest api docs and python client docs
Versioning is built into redocly - https://redocly.com/docs/realm/content/versions and built into material for mkdocs (used for autogeneration) https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
This would require 1. Going back into previous releases and generating the docs for them 2. Creating a hook to generate static docs when a new release is made 3. Creating an automatic method for removing/marking depreciated documentation for versions that are no longer supported
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 existing REST API and Python client documentation, along with the versioning guidance for Redocly and Material for MkDocs linked in the issue. Define how previous releases are generated, how new releases trigger static documentation builds, and how unsupported versions are removed or marked deprecated; done means all three workflows are automated and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100