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

doc: refine CLI help doc #619

Merged
merged 8 commits into from
Sep 27, 2022
Merged

doc: refine CLI help doc #619

merged 8 commits into from
Sep 27, 2022

Conversation

FeynmanZhou
Copy link
Member

@FeynmanZhou FeynmanZhou commented Sep 26, 2022

fix #522
Signed-off-by: Feynman Zhou feynmanzhou@microsoft.com

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou FeynmanZhou changed the title refine CLI help doc [WIP] refine CLI help doc Sep 26, 2022
@FeynmanZhou FeynmanZhou added this to the v0.15.0 milestone Sep 26, 2022
@codecov-commenter
Copy link

codecov-commenter commented Sep 26, 2022

Codecov Report

Merging #619 (4b86958) into main (ea1ee37) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #619   +/-   ##
=======================================
  Coverage   72.12%   72.12%           
=======================================
  Files          14       14           
  Lines         513      513           
=======================================
  Hits          370      370           
  Misses        114      114           
  Partials       29       29           
Impacted Files Coverage Δ
cmd/oras/internal/option/packer.go 81.25% <100.00%> (ø)
cmd/oras/internal/option/remote.go 63.49% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@FeynmanZhou FeynmanZhou added the documentation Documentation related issues label Sep 26, 2022
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou FeynmanZhou marked this pull request as ready for review September 26, 2022 08:27
Copy link
Contributor

@qweeah qweeah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for revising the docs!

@FeynmanZhou FeynmanZhou changed the title [WIP] refine CLI help doc refine CLI help doc Sep 26, 2022
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou FeynmanZhou requested a review from qweeah September 26, 2022 22:58
@qweeah
Copy link
Contributor

qweeah commented Sep 27, 2022

@FeynmanZhou Can you rebase the PR to the latest main branch?

Copy link
Contributor

@qweeah qweeah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

Copy link
Contributor

@qweeah qweeah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@FeynmanZhou FeynmanZhou changed the title refine CLI help doc [doc] refine CLI help doc Sep 27, 2022
@FeynmanZhou FeynmanZhou changed the title [doc] refine CLI help doc [doc:] refine CLI help doc Sep 27, 2022
@FeynmanZhou FeynmanZhou changed the title [doc:] refine CLI help doc doc: refine CLI help doc Sep 27, 2022
@shizhMSFT shizhMSFT merged commit f387005 into oras-project:main Sep 27, 2022
TerryHowe pushed a commit to TerryHowe/oras that referenced this pull request Feb 2, 2023
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve the Help doc command with more examples
4 participants