Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Descriptions and Docs For Cluster Config #409

Open
KPostOffice opened this issue Nov 21, 2023 · 0 comments
Open

Add Descriptions and Docs For Cluster Config #409

KPostOffice opened this issue Nov 21, 2023 · 0 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@KPostOffice
Copy link
Collaborator

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

class ClusterConfiguration:
"""
This dataclass is used to specify resource requirements and other details, and
is passed in as an argument when creating a Cluster object.
"""

@KPostOffice KPostOffice added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
Status: No status
Development

No branches or pull requests

1 participant