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

Document current component/feature maturity #541

Open
mjnagel opened this issue Jul 3, 2024 · 0 comments
Open

Document current component/feature maturity #541

mjnagel opened this issue Jul 3, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mjnagel
Copy link
Contributor

mjnagel commented Jul 3, 2024

Is your feature request related to a problem? Please describe.

Current docs are not clear on whether a given component of uds-core is fully implemented/utilized/stable. It would be helpful to see maturity of given components documented.

Similarly as we add operator features (such as SSO support, networkpolicies, etc) we will likely want to start some of these as "alpha" features, maybe even behind feature flags, and provide a table/list of all features and their current state.

Describe the solution you'd like

When I view the docs site I should see a maturity/status page listing operator features and components of core with clearly defined maturity levels for each.

Describe alternatives you've considered

This could be done per-component/feature rather than aggregated.

This could be captured in release notes rather than docs.

@mjnagel mjnagel added the documentation Improvements or additions to documentation label Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant