Welcome to the Notary Project! This is the repository for the Notary Project website: https://notaryproject.dev/
Our website, powered by Hugo and hosted on Netlify, and serves as your go-to hub for all things related to Notary Project and its associated repositories.

---

The Notary Project is a set of specifications and tools intended to provide a cross-industry standard for securing software supply chains by using authentic container images and other OCI artifacts. Notary Project specification and tooling provides signing and verification workflows for OCI artifacts, signature portability across OCI compliant registries, and integration with 3rd party key management solutions through a plugin model

This website serves as a comprehensive resource for information and documentation on the Notary Project.

You can learn about the overall Notary Project and organization governance from Notary Project README. For detailed information on how to use tools from the Notary Project (such as Notation), see the Notary Project documentation. The remaining content in this README file is specifically intended for building and contributing to the Notary Project website.

Installation

1. Fork this repository and clone it to your development computer.
2. From the terminal, navigate to the directory of your cloned repository.
3. Add the notaryproject/notaryproject.dev repository as a remote named upstream:

git remote add upstream https://github.com/notaryproject/notaryproject.dev.git

Use npm to get the required NPM packages and install the git submodules, or can add -lts to install the latest LTS release of Node:

npm install

Note: By default, this process is performed on the origin/main branch. Ensure you perform this step on a branch based on origin before creating new branches based on upstream/main. Skipping this step may result in incorrect submodule installations.

Building and Serving the Site

To locally serve the site at localhost:8888, run the following command:

npm run serve

To build the site and check links:

npm run build

Cloud-Based IDE

Visit this link to launch it - Gitpod.io IDE-Notary. Start building, previewing, and making changes to this repository.

Contributing

We welcome contributors to contribute to the Notary Project website! We are actively enhancing this site, so we encourage interested individuals to join us and contribute code and documentation. If you encounter any issues or want to share any ideas, please open an issue/PR. You can also provide feedback by joining our Slack Community. For more information, see the contribution guide.

Join Us

Join our growing community around the world!

• Check out our official Blogs
• Join our Slack community in the #notaryproject channel
• Follow us on Twitter.

License

notaryproject.dev is licensed under Apache 2.0.

The Notary Project documentation (e.g., .md files in /content/docs) is licensed under CC-BY-4.0.