Skip to content

Commit

Permalink
updated for v1.2.0 release
Browse files Browse the repository at this point in the history
Signed-off-by: Patrick Zheng <[email protected]>
  • Loading branch information
Two-Hearts committed Aug 15, 2024
1 parent c609608 commit c5df1b9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
2 changes: 1 addition & 1 deletion specs/error-handling-guideline.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Last, error logs can also be useful for post-mortem debugging and can also be wr
- Provide specific and actionable prompt message with argument suggestion or show the example usage for reference. (e.g, Instead of showing flag or argument options is missing, please provide available argument options and guide users to `--help` to view more examples).
- If the actionable prompt message is too long to show in the CLI output, consider guide users to Notation user manual or troubleshooting guide with the versioned permanent link.
- If the error message is not enough for troubleshooting, guide users to use `--verbose` to print much more detailed logs.
- If server returns an error without any [message or detail](https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc.3/spec.md#error-codes), consider providing customized error logs to make it clearer. The original server logs can be displayed in debug mode.
- If server returns an error without any [message or detail](https://github.com/opencontainers/distribution-spec/blob/v1.1.0/spec.md#error-codes), consider providing customized error logs to make it clearer. The original server logs can be displayed in debug mode.
- As a security tool, `notation` SHOULD prompt users to stop upon verification errors.

### Don'Ts
Expand Down
4 changes: 1 addition & 3 deletions specs/notation-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ This spec contains reference information on using notation commands. Each comman
## Notation Commands

| Command | Description |
| ------------------------------------------- | ---------------------------------------------------------------------- |
| [blob](./commandline/blob.md) | Sign, verify and inspect singatures associated with blobs |
| ------------------------------------------- | ---------------------------------------------------------------------- | |
| [certificate](./commandline/certificate.md) | Manage certificates in trust store |
| [inspect](./commandline/inspect.md) | Inspect OCI signatures |
| [key](./commandline/key.md) | Manage keys used for signing |
Expand All @@ -28,7 +27,6 @@ Usage:
notation [command]
Available Commands:
blob Sign, verify and inspect signatures associated with blobs
certificate Manage certificates in trust store
inspect Inspect all signatures associated with a signed OCI artifact
key Manage keys used for signing
Expand Down

0 comments on commit c5df1b9

Please sign in to comment.