Separate hidden and non-hidden commands in lakectl docs #8204
Conversation
This file contains 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
arielshaqed
added
area/lakectl
|
♻️ PR Preview 06ab8ef has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
E2E Test Results - DynamoDB Local - Local Block Adapter |
E2E Test Results - Quickstart |
Also add a scary banner so people know not to use them.
arielshaqed
force-pushed
the
docs/5437-separate-hidden-commands-in-docs
branch
from
a0ee024 to
06ab8ef
Compare
|
("Draft" to decide that this is our preferred solution.) |
itaigilo
reviewed
Sep 22, 2024
| var cliReferenceHiddenCommandsSeparator = ` | ||
| ------- | ||
|
|
||
| ## Undocumented commands |
There was a problem hiding this comment.
A thought:
This section is pretty much at the top of the file, so it pretty much pops up.
If it can be pushed to the bottom of the file, might be nicer I think…
There was a problem hiding this comment.
Not sure, could you explain on the auto-generated CLI reference file in this PR where things should go?
There was a problem hiding this comment.
Well, I can't think of another option actually...
arielshaqed
commented
Sep 26, 2024
itaigilo
approved these changes
Sep 26, 2024
|
Skipping @ozkatz' review and merging - as I believe this is an improvement. I will of course roll back if needed! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Also add a scary banner so people know not to use them.
Closes #5437.