Print warning that command reference is auto-generated#1600
Merged
Brian Strauch (brianstrauch) merged 1 commit intomainfrom Dec 13, 2022
Merged
Print warning that command reference is auto-generated#1600Brian Strauch (brianstrauch) merged 1 commit intomainfrom
Brian Strauch (brianstrauch) merged 1 commit intomainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Checklist
What
It's common for uninitiated docs team members to attempt to edit our auto-generated docs. We should warn them against this with a comment at the top of every auto-generated file.
Test & Review
Tested with a draft docs PR here: https://github.com/confluentinc/docs-confluent-cli/pull/482