-
Notifications
You must be signed in to change notification settings - Fork 235
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
Better help #2733
Merged
Merged
Better help #2733
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
michaeldwan
force-pushed
the
better-help
branch
3 times, most recently
from
August 29, 2023 18:58
5a25ca6
to
72e5b58
Compare
michaeldwan
force-pushed
the
better-help
branch
from
August 29, 2023 22:03
72e5b58
to
5706dda
Compare
michaeldwan
force-pushed
the
better-help
branch
from
August 29, 2023 23:20
5706dda
to
6021e72
Compare
I wonder if there is any tool that checks for broken URLs. |
@redjonzaci that's a good idea! I'll add it to the audit tool. |
gwuah
approved these changes
Aug 30, 2023
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.
good set of changes + good PR description.
wjordan
added a commit
that referenced
this pull request
Sep 1, 2023
Followup fix for #2733 for proper `fly help` output.
wjordan
added a commit
that referenced
this pull request
Sep 1, 2023
Followup fix for #2733 for proper `fly help` output.
catflydotio
pushed a commit
to superfly/docs
that referenced
this pull request
Sep 4, 2023
catflydotio
pushed a commit
to superfly/docs
that referenced
this pull request
Sep 4, 2023
catflydotio
added a commit
to superfly/docs
that referenced
this pull request
Sep 4, 2023
* adapt to deprecations in superfly/flyctl#2733 * don't put nested commands in flyctl nav * Tidy callout language
bradgessler
pushed a commit
to superfly/docs
that referenced
this pull request
Sep 29, 2023
* adapt to deprecations in superfly/flyctl#2733 * don't put nested commands in flyctl nav * Tidy callout language
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.
This PR revamps help text for the
fly
command and its subcommands. The goal is to make our help text more helpful, easier to read, and easier to maintain going forward. This only addresses the framework for how help text is rendered. Updating the oodles of individual commands and flags will come in subsequent PRs.Read on for an overview of what's new.
Improved Formatting
Old Output, wrapped at 120 characters
New Output, wrapped at 120 characters
fly
"getting started" outputRunning
fly
without any commands, flags, or args has been printing common commands to help users get started for some time. This PR updates the output with more emphasis on the "launch" flow, cleaner formatting, and includes additional resources for help, like the community forum url.Old output
New output
Command grouping for
fly help
andfly --help
For a while now running
fly help
would print a manually curated list of commands, grouped by theme. This went a long way to taming the massive list of commands at the root. But there were two issues with it:fly console
were missingfly help
. Runningfly --help
(which was suggested everywhere) would still show the default output which included an obnoxious list of 54 commandsThis PR fixes these issues by taking advantage of cobra's newish command grouping feature. We tag individual commands with a group, and anytime help text is printed, the grouping will reflect it. Formatting and dynamic wrapping apply as well. Commands without a group are still shown in an "Additional Commands" section, so new command won't be inadvertantly hidden. And behavior is consistent between
fly help
andfly --help
.Old `fly help` output:
Old `fly --help` output:
New `fly help` and `fly --help` output:
Hiding and deprecating commands
In order to keep the root command list tidy, I've marked the following commands as hidden and added a deprecation message if not already set. These commands have all been mentioned as being deprecated, most printed a message already, so no surprises expected. They'll get removed in like a week.
fly create
- deprecated in favor offly apps create
fly curl
- deprecated, pending removalfly destroy
- deprecated in favor offly apps destroy
fly dns-records
and children - deprecated, pending removalfly domains
and children - deprecated, pending removalfly history
- deprecated in favor offly apps releases
fly move
- deprecated in favor offly apps move
fly open
- deprecated in favor offly apps open
fly resume
- deprecated in favor offly scale count
fly suspend
- deprecated in favor offly scale count