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

ADR to consider adding feature mature in the documentation #115

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

enekofb
Copy link
Contributor

@enekofb enekofb commented Apr 27, 2023

This PR raises an ADR to determine if we should provide guidance on the user documentation about feature maturity and if so, how to express that in a way that is effective without side-effects.

Currently in draft as it is just to present the problem statement, and a few potential actions for further input from prod-engineering.

@enekofb enekofb force-pushed the adr/feature-maturity-documentation branch from e2b6f1d to 4b6a737 Compare April 27, 2023 08:56
@squaremo
Copy link
Contributor

Are experimental (or otherwise not production-ready) features flagged as such in the user interface itself?

@enekofb
Copy link
Contributor Author

enekofb commented Apr 27, 2023

Are experimental (or otherwise not production-ready) features flagged as such in the user interface itself?

No, we don't have maturity showing in the UI either. It is definitely in the same context but potentially provides info to end users. Documentation could be end users or admins like customer-side platform engineers or CRE.

@enekofb
Copy link
Contributor Author

enekofb commented Apr 27, 2023

From @lizwarner-weave

  • Check with comercial team
  • Either "alpha / stable" to be a feature flag

@enekofb
Copy link
Contributor Author

enekofb commented Apr 27, 2023

From @bigkevmcd

  • Security not something that could measured in maturity is a yes o no -> security posture is

From @squaremo

  • +1 on both previous
  • we should include it in the UI too

@enekofb
Copy link
Contributor Author

enekofb commented Apr 27, 2023

From @serboctor

  • framing not from the stability but from the early access and the request for input

@enekofb
Copy link
Contributor Author

enekofb commented Apr 27, 2023

Summary

  • happy to explore that better expectations approach but to check with commercial team on the best approach for users and sales.

Jeff - @chawklit

@enekofb
Copy link
Contributor Author

enekofb commented May 12, 2023

From @chawklit

  • to have product updates in blogposts
  • alpha / beta / stable seems adequate for the purpose. dont think will disincentive trying (but for example alpha might not in prod)
  • to follow up with @joe-terrible @darrylweaver to get their input

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants