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

Add examples for the flag "--format" #1422

Open
1 task
FeynmanZhou opened this issue Jun 21, 2024 · 1 comment
Open
1 task

Add examples for the flag "--format" #1422

FeynmanZhou opened this issue Jun 21, 2024 · 1 comment
Assignees
Labels
documentation Documentation related issues format output
Milestone

Comments

@FeynmanZhou
Copy link
Member

FeynmanZhou commented Jun 21, 2024

What happened in your environment?

After upgraded to ORAS v1.2.0, I noticed that there are no any examples of the flag --format in ORAS CLI command help reference. Users might be hard to understand how to use --format in ORAS CLI commands

image

What did you expect to happen?

It would be much user-friendly if we could add basic examples for the flag "--format" in the help reference.

How can we reproduce it?

Run "--help" in each oras command

What is the version of your ORAS CLI?

oras v1.2.0

What is your OS environment?

Ubuntu 22.06

Are you willing to submit PRs to fix it?

  • Yes, I am willing to fix it.
@FeynmanZhou FeynmanZhou added bug Something isn't working triage New issues or PRs to be acknowledged by maintainers labels Jun 21, 2024
@qweeah qweeah changed the title Add examples for the flag "--fortmat" Add examples for the flag "--format" Jun 21, 2024
@shizhMSFT
Copy link
Contributor

We are having more and more examples in the Example section of the help. Sometimes, it is hard for me to find the usage and flag usages.

Should we consider man pages instead of --help? That is,

man oras

or maybe in PowerShell

Get-Help oras

@qweeah qweeah removed the triage New issues or PRs to be acknowledged by maintainers label Jun 28, 2024
@qweeah qweeah added this to the v1.3.0 milestone Jun 28, 2024
@FeynmanZhou FeynmanZhou added documentation Documentation related issues and removed bug Something isn't working labels Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related issues format output
Projects
None yet
Development

No branches or pull requests

4 participants