Skip to content

Commit

Permalink
Fixed broken links on the Notary Project dev site (#352)
Browse files Browse the repository at this point in the history
This PR fixes #351

---------

Signed-off-by: Roseline <[email protected]>
  • Loading branch information
Roseline-Bassey authored Sep 14, 2023
1 parent 9b88d58 commit 21d3197
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h4 class="title">
Signing and verifying artifacts. Safeguarding the software delivery security from development to deployment.
</p>
<div class="gap-md margin-lg-top text-centered-mobile flex">
<a href="https://notaryproject.dev/docs/quickstart/">
<a href="https://notaryproject.dev/docs/quickstart-guides/quickstart/">
<button class="button is-medium is-dark get-started">Get started</button>
</a>
<a href="https://killercoda.com/notaryproject/scenario/notation" target="_blank" rel="noopener noreferrer">
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/user-guides/how-to/manage-trust-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ type: docs
weight: 2
---

By default, `notation` configures and manages a trust policy in the [configuration directory]({{< ref "/docs/user-guides/how-to/notary-project-concepts.md" >}}). You can directly change the trust policy file in that directory to manage your trust policies.
By default, `notation` configures and manages a trust policy in the [configuration directory]({{< ref "/docs/user-guides/how-to/directory-structure.md" >}}). You can directly change the trust policy file in that directory to manage your trust policies.

Alternatively, you can manage trust policies using the `notation policy import` and `notation policy show` commands. These commands have the following benefits over directly editing the default trust policy file:

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/user-guides/how-to/notation-config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This guide demonstrates how to customize the Notation system configuration in `c
The configuration file `config.json` location is different per operating system. `signingkeys.json` will be generated and stored in the same directory with `config.json`. You can use the Notation CLI or libraries to alter locations through the `XDG_CONFIG_HOME` environment variable.

{{% alert title="Note" color="primary" %}}
You can find the details of Notation directory structure for system configuration in this [guide]({{< ref "/docs/user-guides/how-to/notary-project-concepts.md" >}}).
You can find the details of Notation directory structure for system configuration in this [guide]({{< ref "/docs/user-guides/how-to/directory-structure.md" >}}).
{{% /alert %}}

### Linux
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/user-guides/how-to/plugin-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Before creating the `{plugin-name}` directory, confirm you are using a name that
The following example downloads and installs version 0.6.0 of [notation-azure-kv](https://github.com/Azure/notation-azure-kv) plugin for on macOS with Apple Silicon using the default location for the Notation installation.

{{% alert title="Warning" color="warning" %}}
The following example only works for version 0.6.0 of the *notation-azure-kv* plugin on macOS with Apple Silicon using the default location for the Notation installation. You will need to update the filenames, location, and commands for other plugins, versions, and platforms. For more details on the default location of that directory on each platform, see [Notation directory structure for system configuration]({{< ref "/docs/user-guides/how-to/notary-project-concepts.md" >}}).
The following example only works for version 0.6.0 of the *notation-azure-kv* plugin on macOS with Apple Silicon using the default location for the Notation installation. You will need to update the filenames, location, and commands for other plugins, versions, and platforms. For more details on the default location of that directory on each platform, see [Notation directory structure for system configuration]({{< ref "/docs/user-guides/how-to/directory-structure.md" >}}).
{{% /alert %}}

```console
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/user-guides/how-to/registry-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ By default, `notation` uses a credentials store during the following operations:
- Delete credentials from the credentials store when you log out of a registry

You have three options for configuring a credentials store:
1. Use the [`notation` config.json file]({{< ref "/docs/user-guides/how-to/notary-project-concepts.md" >}}).
1. Use the [`notation` config.json file]({{< ref "/docs/user-guides/how-to/directory-structure.md" >}}).
1. Use the Docker configuration file, which is located at `~/.docker/config.json`.
1. Use the default credentials store for your operating system.

Expand All @@ -31,7 +31,7 @@ If you have Docker installed on your system and used `docker login` to authentic
Docker also implements a fallback mechanism for storing your credentials. If no credentials store is available, Docker will store your credentials as base64 encoded values in the Docker configuration file. This is not secure and is not recommended for production environments. For more details, see [`docker login` default behavior](https://docs.docker.com/engine/reference/commandline/login/#default-behavior).
{{% /alert %}}

To configure a credentials store in the `notation` configuration file, add a `credStore` to the [`notation` config.json file]({{< ref "/docs/user-guides/how-to/notary-project-concepts.md" >}}). The following example shows `osxkeychain` as the configured credentials store.
To configure a credentials store in the `notation` configuration file, add a `credStore` to the [`notation` config.json file]({{< ref "/docs/user-guides/how-to/directory-structure.md" >}}). The following example shows `osxkeychain` as the configured credentials store.

```json
{
Expand Down Expand Up @@ -79,7 +79,7 @@ unset NOTATION_PASSWORD
Storing credentials in `config.json` is not secure for storing sensitive data such as usernames and passwords and should not be used in a production environment.
{{% /alert %}}

You can configure the [`notation` config.json file]({{< ref "/docs/user-guides/how-to/notary-project-concepts.md" >}}) to store the credentials for your OCI-compliant registry as base64 encoded values. For example:
You can configure the [`notation` config.json file]({{< ref "/docs/user-guides/how-to/directory-structure.md" >}}) to store the credentials for your OCI-compliant registry as base64 encoded values. For example:

```json
{
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/user-guides/installation/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,5 +167,5 @@ Alternatively, you can expand the archive file to a different directory and add

For more on the `NOTATION_CONFIG` directory and configuring your environment with `notation` see:

- [Notation directory structure for system configuration]({{< ref "/docs/user-guides/how-to/notary-project-concepts.md" >}})
- [Notation directory structure for system configuration]({{< ref "/docs/user-guides/how-to/directory-structure.md" >}})
- [Customize the Notation configuration file]({{< ref "/docs/user-guides/how-to/notation-config-file" >}})
2 changes: 1 addition & 1 deletion content/en/docs/user-guides/installation/uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `notation` CLI uses the following directories for its binaries and configura
- `NOTATION_CONFIG` is the directory for the configuration files, including trust stores and trust policies.

{{% alert title="Important" color="info" %}}
`notation` has default values for `NOTATION_BIN`, `NOTATION_LIBEXEC`, or `NOTATION_CONFIG`, but `notation` does not set those environment variables. These environment variables are optional, but if you wish to override the default values, you can set them to another value. For more details on each directory as well as the default location of those directories on each platform, see [Notation directory structure for system configuration]({{< ref "/docs/user-guides/how-to/notary-project-concepts.md" >}}).
`notation` has default values for `NOTATION_BIN`, `NOTATION_LIBEXEC`, or `NOTATION_CONFIG`, but `notation` does not set those environment variables. These environment variables are optional, but if you wish to override the default values, you can set them to another value. For more details on each directory as well as the default location of those directories on each platform, see [Notation directory structure for system configuration]({{< ref "/docs/user-guides/how-to/directory-structure.md" >}}).
{{% /alert %}}

## Remove the notation CLI
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/user-guides/secure-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A deployment of Notation, specifically the `notation` CLI, is used for signing a
A deployment has several sensitive components:

- [Trust policies]({{< ref "/docs/user-guides/how-to/manage-trust-policy" >}})
- [Trust stores and certificates]({{< ref "/docs/user-guides/how-to/notary-project-concepts.md" >}})
- [Trust stores and certificates]({{< ref "/docs/user-guides/how-to/directory-structure.md" >}})
- Plugins

It is strongly recommended that you follow the best practices in this document to secure your deployment of Notation. Notation works with a shared responsibility model, meaning users and organizations are responsible for securing the `notation` CLI deployment.
Expand Down

0 comments on commit 21d3197

Please sign in to comment.