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

added notation CLI reference docs based on RC4 #183

Merged
merged 1 commit into from
Apr 27, 2023

Conversation

zr-msft
Copy link
Collaborator

@zr-msft zr-msft commented Apr 25, 2023

fixes #163

@netlify
Copy link

netlify bot commented Apr 25, 2023

Deploy Preview for notarydev ready!

Name Link
🔨 Latest commit bc30d5e
🔍 Latest deploy log https://app.netlify.com/sites/notarydev/deploys/64497e548cf3ea00078d55b8
😎 Deploy Preview https://deploy-preview-183--notarydev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

yizha1
yizha1 previously approved these changes Apr 26, 2023
Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

LGTM.
@zr-msft One question: I didn't see sub-commands for notation sign and notation verify. Do you plan to add them later?

@FeynmanZhou
Copy link
Member

FeynmanZhou commented Apr 26, 2023

@zr-msft Could you add a code block effect for each CLI command example like https://oras.land/cli_reference/? It would be much more convenient for users to copy. We will also add a Copy button to the code block soon. The layout will be much more comfortable if we put the example CLI command in the code block.

@FeynmanZhou
Copy link
Member

Signed-off-by: Zach Rhoads <zachary.rhoads@microsoft.com>
@zr-msft
Copy link
Collaborator Author

zr-msft commented Apr 26, 2023

manually added code blocks to examples for now. Still need to research better automated generation of these changes, but thats out of scope for this PR

Copy link
Member

@FeynmanZhou FeynmanZhou 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 requested a review from yizha1 April 27, 2023 04:07
Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

LGTM for a first version

@yizha1 yizha1 merged commit 617f9bd into notaryproject:main Apr 27, 2023
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.

Create a chapter for CLI reference doc
3 participants