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 OCI layout support in command help doc #904

Closed
1 task
qweeah opened this issue Mar 24, 2023 · 4 comments · Fixed by #997
Closed
1 task

add OCI layout support in command help doc #904

qweeah opened this issue Mar 24, 2023 · 4 comments · Fixed by #997
Labels
bug Something isn't working documentation Documentation related issues good first issue Good for newcomers
Milestone

Comments

@qweeah
Copy link
Contributor

qweeah commented Mar 24, 2023

What happened in your environment?

Below command do support operating an OCI layout folder, but the short and long description only mentioned the support for remote registry

  • oras discover
  • oras pull
  • oras push
  • oras tag
  • oras blob
  • oras blob push
  • oras blob fetch
  • oras manifest
  • oras manifest push
  • oras manifest fetch
  • oras manifest fetch-config

What did you expect to happen?

Short and long description of below commands should mention OCI layout support.

  • oras discover
  • oras pull
  • oras push
  • oras tag
  • oras blob
  • oras blob push
  • oras blob fetch
  • oras manifest
  • oras manifest push
  • oras manifest fetch
  • oras manifest fetch-config

How can we reproduce it?

Run <command> -h

What is the version of your ORAS CLI?

1.0.0

What is your OS environment?

20.04

Are you willing to submit PRs to fix it?

  • Yes, I am willing to fix it.
@qweeah qweeah added bug Something isn't working documentation Documentation related issues labels Mar 24, 2023
@qweeah qweeah added this to the v1.1.0 milestone Mar 24, 2023
@FeynmanZhou
Copy link
Member

FeynmanZhou commented Mar 24, 2023

Agree. Do we need to update the CLI help info in the ORAS CLI code repo either?

BTW, it's recommended that create a separate guide to elaborate on the OCI layout usage.

@qweeah qweeah added the good first issue Good for newcomers label Mar 24, 2023
@qweeah
Copy link
Contributor Author

qweeah commented Mar 24, 2023

Do we need to update the CLI help info in the ORAS CLI code repo either?

Yes, this issue is to track changes in ORAS CLI code

it's recommended that create a separate guide to elaborate on the OCI layout usage.

Indeed, but the short description should not be limited to registry only, e.g. for oras discover the description is Discover referrers of a manifest in the remote registry , which should be sth like Discover referrers of an artifact

@rafiya2003
Copy link

I would like to work on this, frankly I don't know much but I will learn and do. I am a newbie(first year UG student). I want to learn and grow. please give me the opportunity to learn and experience

@qweeah
Copy link
Contributor Author

qweeah commented Jun 5, 2023

@rafiya2003 Hi Rafiya, welcome to oras & thanks for your interest. This issue is critical for the upcoming release 1.1.0, so considering the urgency of the time it's not suitable for new contributors.

If you are interested, do you like to work on #742? It's also a good first issue and not included in 1.1.0 release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Documentation related issues good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants