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.

Sign up for GitHub

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

Jump to bottom

Hidden commands in Docs #5437

Closed
rmoff opened this issue Mar 10, 2023 · 2 comments · Fixed by #8204
Closed

Hidden commands in Docs #5437

rmoff opened this issue Mar 10, 2023 · 2 comments · Fixed by #8204
Assignees
@arielshaqed
Labels
area/lakectl Issues related to lakeFS' command line interface (lakectl) docs Improvements or additions to documentation stale team/versioning-engine Team versioning engine

Comments

@rmoff
Copy link
Contributor

rmoff commented Mar 10, 2023

At the moment the docs for lakectl include all of the hidden commands inline with normal commands

746ae32b025bb9ceae78e4722b18845e3562a830991cda56a11b659da5a1d48a

This is different from the CLI's help itself, which does not include them:

e7c4374602b417a3c17bde30b17137a1fa0ed5341b77a46bbae2041eb77c8897

To make the docs clearer for users I would like to propose that we do one of the following:

  1. Don't include hidden commands in the docs
  2. Move hidden commands into their own doc
  3. Move hidden commands into an appendix on the existing doc page
@rmoff rmoff added area/lakectl Issues related to lakeFS' command line interface (lakectl) docs Improvements or additions to documentation labels Mar 10, 2023
@nopcoder nopcoder assigned nopcoder and unassigned nopcoder Mar 15, 2023
@nopcoder nopcoder added the team/versioning-engine Team versioning engine label Mar 15, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 1, 2023

This issue is now marked as stale after 90 days of inactivity, and will be closed soon. To keep it, mark it with the "no stale" label.

@github-actions github-actions bot added the stale label Nov 1, 2023
@github-actions GitHub Actions
Copy link

Closing this issue because it has been stale for 7 days with no activity.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Nov 10, 2023
@arielshaqed arielshaqed self-assigned this Sep 19, 2024
@arielshaqed arielshaqed mentioned this issue Sep 22, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@arielshaqed arielshaqed

Labels
area/lakectl Issues related to lakeFS' command line interface (lakectl) docs Improvements or additions to documentation stale team/versioning-engine Team versioning engine
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Separate hidden and non-hidden commands in lakectl docs treeverse/lakeFS
3 participants
@nopcoder @rmoff @arielshaqed