codeflare-sdk
codeflare-sdk copied to clipboard
Add Descriptions and Docs For Cluster Config
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
Is this something that can be picked up? I can contribute if required.