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 internal property warning #479

Merged
merged 4 commits into from
May 31, 2024
Merged

add internal property warning #479

merged 4 commits into from
May 31, 2024

Conversation

Deflaimun
Copy link
Collaborator

@Deflaimun Deflaimun commented May 6, 2024

@Deflaimun Deflaimun requested a review from a team as a code owner May 6, 2024 13:55
Copy link

netlify bot commented May 6, 2024

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit e9417a7
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/665a12115c1e0c0008a39c75
😎 Deploy Preview https://deploy-preview-479--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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^].
Copy link
Collaborator

@Feediver1 Feediver1 May 6, 2024

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.

Copy link
Collaborator Author

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?

Copy link
Collaborator Author

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.

@Deflaimun Deflaimun merged commit df4140e into main May 31, 2024
5 checks passed
@Deflaimun Deflaimun deleted the 2373-internal-property branch May 31, 2024 18:32
Deflaimun added a commit that referenced this pull request Jun 5, 2024
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.

None yet

4 participants