Skip to content

Commit

Permalink
Update download link and refactor the documentation directory (notary…
Browse files Browse the repository at this point in the history
  • Loading branch information
FeynmanZhou authored Aug 25, 2022
1 parent 4bf25df commit c56a4ba
Showing 1 changed file with 22 additions and 12 deletions.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![codecov](https://codecov.io/gh/notaryproject/notation/branch/main/graph/badge.svg)](https://codecov.io/gh/notaryproject/notation)

Notation is a project to add signatures as standard items in the registry ecosystem, and to build a set of simple tooling for signing and verifying these signatures. This should be viewed as similar security to checking git commit signatures, although the signatures are generic and can be used for additional purposes. Notation is an implementation of the [Notary V2 specifications][notaryv2-specs].
Notation is a CLI project to add signatures as standard items in the registry ecosystem, and to build a set of simple tooling for signing and verifying these signatures. This should be viewed as similar security to checking git commit signatures, although the signatures are generic and can be used for additional purposes. Notation is an implementation of the [Notary V2 specifications][notaryv2-specs].

## Table of Contents

Expand All @@ -19,7 +19,7 @@ Notation is a project to add signatures as standard items in the registry ecosys

- Install the Notation CLI from [Notation Releases][notation-releases]
```bash
curl -Lo notation.tar.gz https://github.com/notaryproject/notation/releases/download/v0.9.0-alpha.1/notation_0.9.0-alpha.1_linux_amd64.tar.gz
curl -Lo notation.tar.gz https://github.com/notaryproject/notation/releases/download/v0.10.0-alpha.3/notation_0.10.0-alpha.3_linux_amd64.tar.gz
tar xvzf notation.tar.gz -C ~/bin notation
```
- Run a local instance of the [CNCF Distribution Registry][cncf-distribution], with [ORAS Artifacts][artifact-manifest] support.
Expand All @@ -41,18 +41,28 @@ Notation is a project to add signatures as standard items in the registry ecosys

Signatures are persisted as [ORAS Artifacts manifests][artifact-manifest].

For more detailed samples, see [hello-signing](docs/hello-signing.md)

## Core Documents
## Documents

- [Hello World for Notation: Local signing and verification](docs/hello-signing.md)
- [Build, sign, and verify container images using Notary and Azure Key Vault](https://docs.microsoft.com/azure/container-registry/container-registry-tutorial-sign-build-push)

- [Governance for Notation](https://github.com/notaryproject/notary/blob/master/GOVERNANCE.md)
- [Maintainers and reviewers list](https://github.com/notaryproject/notary/blob/master/MAINTAINERS)

## Community

### Development and Contributing

- [Build Notation from source code](/building.md)
- [Governance for Notation](https://github.com/notaryproject/notary/blob/master/GOVERNANCE.md)
- [Maintainers and reviewers list](https://github.com/notaryproject/notary/blob/master/MAINTAINERS)
- Regular conversations for Notation occur on the [Cloud Native Computing Slack](https://slack.cncf.io/) **notary-v2** channel.
- Please see the [CNCF Calendar](https://www.cncf.io/calendar/) for community meeting details.
- Meeting notes are captured on [hackmd.io](https://hackmd.io/_vrqBGAOSUC_VWvFzWruZw).

### Notary v2 Community Meeting

- Mondays 5-6pm pacific time, 8-9pm US Eastern, 8-9am Shanghai
- Thursdays 9-10am pacific time, 12pm US Eastern, 5pm UK

Join us at [Zoom Dial-in link](https://zoom.us/my/cncfnotaryproject) / Passcode: 77777. Please see the [CNCF Calendar](https://www.cncf.io/calendar/) for community meeting details. Meeting notes are captured on [hackmd.io](https://hackmd.io/_vrqBGAOSUC_VWvFzWruZw).

## Release Management

Expand All @@ -70,7 +80,7 @@ This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foun

This project is covered under the Apache 2.0 license. You can read the license [here](LICENSE).

[notation-releases]: https://github.com/notaryproject/notation/releases
[notaryv2-specs]: https://github.com/notaryproject/notaryproject
[artifact-manifest]: https://github.com/oras-project/artifacts-spec/blob/main/artifact-manifest.md
[cncf-distribution]: https://github.com/oras-project/distribution
[Notation Releases]: https://github.com/notaryproject/notation/releases
[Notary v2 Specs]: https://github.com/notaryproject/notaryproject
[ORAS artifact-manifest]: https://github.com/oras-project/artifacts-spec/blob/main/artifact-manifest.md
[CNCF Distribution]: https://github.com/oras-project/distribution

0 comments on commit c56a4ba

Please sign in to comment.