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

docs: add documentation for oras completion #246

Merged
merged 6 commits into from
Aug 17, 2023

Conversation

deepeshaburse
Copy link
Contributor

This PR adds documentation for oras completion.

@deepeshaburse
Copy link
Contributor Author

The order of the commands will be correct after the PR #245 gets merged.

@deepeshaburse
Copy link
Contributor Author

cc: @TerryHowe

Deepesha Burse added 2 commits August 8, 2023 15:46
Signed-off-by: Deepesha Burse <deepeshaburse@Deepeshas-MacBook-Air.local>
Signed-off-by: Deepesha Burse <deepeshaburse@Deepeshas-MacBook-Air.local>
Copy link
Member

@TerryHowe TerryHowe left a comment

Choose a reason for hiding this comment

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

Most of the commands pages are pretty much generated from running the help on the command. The format of this doesn't really match the rest of the commands. This reads more like a how-to which I think would be useful.

@deepeshaburse
Copy link
Contributor Author

Most of the commands pages are pretty much generated from running the help on the command. The format of this doesn't really match the rest of the commands. This reads more like a how-to which I think would be useful.

True, I feel that would be more helpful. Writing documentation similar to the other commands isn't really possible for this one specifically. How about giving a 1-2 liner intro to the command under ORAS commands and then add the link to a how-to guide with this content?

docs/commands/oras_completion.mdx Outdated Show resolved Hide resolved
docs/commands/oras_completion.mdx Show resolved Hide resolved
deepeshaburse and others added 2 commits August 10, 2023 19:34
Co-authored-by: Terry Howe <terrylhowe@gmail.com>
Signed-off-by: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.com>
Co-authored-by: Terry Howe <terrylhowe@gmail.com>
Signed-off-by: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.com>
TerryHowe
TerryHowe previously approved these changes Aug 11, 2023
Copy link
Member

@TerryHowe TerryHowe left a comment

Choose a reason for hiding this comment

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

/lgtm

Co-authored-by: Sajay Antony <sajaya@microsoft.com>
Signed-off-by: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.com>
Copy link
Member

@TerryHowe TerryHowe left a comment

Choose a reason for hiding this comment

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

/lgtm

@sajayantony sajayantony merged commit 8b7e22c into oras-project:main Aug 17, 2023
6 checks passed
@deepeshaburse deepeshaburse deleted the oras-completion branch August 21, 2023 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants