-
Notifications
You must be signed in to change notification settings - Fork 26
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 internal property warning #479
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@@ -0,0 +1 @@ | |||
WARNING: This property is for Redpanda internal use only. Do not modify it unless specifically instructed by https://support.redpanda.com/hc/en-us[Redpanda Support^]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So does this appear once at the top of the topic? If so, then:
WARNING: This property is for Redpanda internal use only. Do not use or modify any property here unless specifically instructed to do so by https://support.redpanda.com/hc/en-us[Redpanda Support^]. Using any property here without explicit guidance from Redpanda support could result in data loss.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. The idea here is to inject this admonition into every property that is meant for internal-only usage.
Do you want to create a separate section for those properties?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Going with individual admonitions for properties after a decision in a Zoom Call.
Resolves https://github.com/redpanda-data/documentation-private/issues/2373
Fixes: DOC-198