project-codeflare / project-codeflare/codeflare-sdk
Add Descriptions and Docs For Cluster Config
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 35
- Forks
- 66
- Avg merge
- 48m
- Merged PRs (30d)
- 7
Description
Name of Feature or Improvement
The documentation around the cluster configuration options is not easy for users to find and grok the features that are exposed.
Description of Problem the Feature Should Solve
Users should be able to confidently use new features exposed through the cluster configuration. (i.e. openshift_oauthproxy)
Describe the Solution You Would Like to See
Expand the documentation for ClusterConfig to include descriptions of each parameter
https://github.com/project-codeflare/codeflare-sdk/blob/083a2ea8a82fab00913228e3d200b458d9e3171e/src/codeflare_sdk/cluster/config.py#L28-L32
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 src/codeflare_sdk/cluster/config.py at the linked ClusterConfig definition and review the existing parameter documentation. Expand the descriptions for each ClusterConfig parameter, including features such as openshift_oauthproxy. Done means users can find and understand every exposed cluster configuration option.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100