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.

Sign up for GitHub

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

Jump to bottom

Add examples for notation command help doc #383

Closed
5 tasks
FeynmanZhou opened this issue Oct 12, 2022 · 0 comments · Fixed by #384, #394 or #454
Closed
5 tasks

Add examples for notation command help doc #383

FeynmanZhou opened this issue Oct 12, 2022 · 0 comments · Fixed by #384, #394 or #454
Assignees
@FeynmanZhou
Labels
UX User experience changes
Milestone
alpha-4

Comments

@FeynmanZhou
Copy link
Member

FeynmanZhou commented Oct 12, 2022 •
edited
Loading

We need to add more examples in --help information for each command in Alpha.4. These examples will be straightforward and easy to understand the typical usage of each command line with its flags.

Users can easily find these references using the --help for each notation command line and its flag. This will be a good foundation for further updates.

  • notation sign
  • notation verify
  • notation key
  • notation certificate
  • notation plugin
@FeynmanZhou FeynmanZhou added this to the alpha-4 milestone Oct 12, 2022
@FeynmanZhou FeynmanZhou self-assigned this Oct 12, 2022
@FeynmanZhou FeynmanZhou added docs UX User experience changes labels Oct 12, 2022
@FeynmanZhou FeynmanZhou mentioned this issue Oct 12, 2022
Merged
@yizha1 yizha1 moved this from Todo to In Progress in Notary Project Planning Board Oct 13, 2022
@FeynmanZhou FeynmanZhou mentioned this issue Oct 13, 2022
Merged
shizhMSFT pushed a commit that referenced this issue Oct 14, 2022
@FeynmanZhou
doc: add examples in CLI help doc for notation sign and verify (#384)
b9f1fb5 
fix #383

Signed-off-by: Feynman Zhou <[email protected]>
Repository owner moved this from In Progress to Done in Notary Project Planning Board Oct 14, 2022
@FeynmanZhou FeynmanZhou reopened this Nov 25, 2022
Repository owner moved this from Done to In Progress in Notary Project Planning Board Nov 25, 2022
@FeynmanZhou FeynmanZhou mentioned this issue Nov 25, 2022
Merged
priteshbandi pushed a commit that referenced this issue Dec 2, 2022
@FeynmanZhou
doc: update CLI help doc for notation sign and verify in RC.1 (#454)
a6e6fa0 
fix #383

Signed-off-by: Feynman Zhou <[email protected]>
Repository owner moved this from In Progress to Done in Notary Project Planning Board Dec 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@FeynmanZhou FeynmanZhou

Labels
UX User experience changes
Projects
Notary Project Planning Board
Status: Done
Milestone
alpha-4
1 participant
@FeynmanZhou