camunda / camunda/orchestration-cluster-api-python
Documentation integration with Camunda Docs for stable releases
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- Avg merge
- 6h 15m
- Merged PRs (30d)
- 20
Description
Documentation is integrated with Camunda Docs.
This is done using the same IOC pattern in CI that the Camunda API Docs uses. The README from this repository is used to generate documentation pages. That means that the structure of the README is important and should not be changed.
What needs to happen now is wiring up integration from the Python SDK stable branches to the appropriate directory in Camunda Docs.
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 repository README and the CI configuration that uses the IOC pattern described for Camunda API Docs. Review how the Python SDK stable branches are identified and determine the appropriate Camunda Docs directory. Done means those stable branches are wired into the corresponding documentation integration without changing the README structure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100