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

Refine help output for generic flags #6207

Open
rm3l opened this issue Oct 10, 2022 · 4 comments
Open

Refine help output for generic flags #6207

rm3l opened this issue Oct 10, 2022 · 4 comments
Labels
area/UX Issues or PRs related to User Experience lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/Low Nice to have issue. It's not immediately on the project roadmap to get it done.

Comments

@rm3l
Copy link
Member

rm3l commented Oct 10, 2022

    Just a discussion (also applies to the `run-on` flag):

From the user perspective, now that these two flags are visible globally, can the odo help output provide more guidance by telling users which commands these flags can be used with? I understand this would mean maintaining these descriptions, but I think it would be helpful.
So I'd suggest something like:

	pflag.CommandLine.String(VarFileFlagName, "", "File containing variables to override Devfile variables. Usable with \"odo dev\" and \"odo deploy\" commands.")

What do you think?

Because currently, users have to explicitly run the command to see if the flag can be used or not, e.g.:

> odo init --var USER                                                             
 ✗  --var-file and --var flags are not supported for this command

Originally posted by @rm3l in #6201 (comment)

@kadel kadel added the area/UX Issues or PRs related to User Experience label Mar 9, 2023
@github-actions
Copy link
Contributor

A friendly reminder that this issue had no activity for 90 days. Stale issues will be closed after an additional 30 days of inactivity.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 28, 2023
@github-actions
Copy link
Contributor

This issue was closed because it has been inactive for 30 days since being marked as stale.

@github-actions github-actions bot added the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Sep 27, 2023
@rm3l
Copy link
Member Author

rm3l commented Sep 27, 2023

Still relevant from the CLI UX perspective.

/remove-lifecycle stale
/remove-lifecycle rotten
/priority Low

@openshift-ci openshift-ci bot added priority/Low Nice to have issue. It's not immediately on the project roadmap to get it done. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Sep 27, 2023
@rm3l rm3l reopened this Sep 27, 2023
@github-actions github-actions bot added the needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. label Sep 27, 2023
Copy link
Contributor

A friendly reminder that this issue had no activity for 90 days. Stale issues will be closed after an additional 30 days of inactivity.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 27, 2023
@rm3l rm3l added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. labels Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/UX Issues or PRs related to User Experience lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/Low Nice to have issue. It's not immediately on the project roadmap to get it done.
Projects
Status: No status
Development

No branches or pull requests

2 participants