fix: spelling errors detected by vale (#389)

oras-project · Sep 14, 2024 · d45e83f · d45e83f
1 parent a8e3be1
commit d45e83f
Show file tree

Hide file tree

Showing 20 changed files with 26 additions and 26 deletions.
diff --git a/community/contributing_guide.mdx b/community/contributing_guide.mdx
@@ -123,7 +123,7 @@ The recommendation is to follow [semantic line breaks][sembr].
 All contributors to the project retain copyright to their work. However, to
 ensure that they are only submitting work that they have rights to, we require
 everyone to acknowledge this by signing their work. Any copyright notices in
-this repo should specify the authors as "The ORAS Authors".
+this repository should specify the authors as "The ORAS Authors".
 
 Licensing is important to open source projects. It provides some assurances that
 the software will continue to be available based under the terms that the

diff --git a/community/developer_guide.mdx b/community/developer_guide.mdx
@@ -106,7 +106,7 @@ This section needs a lot of love and automation 🙂
 1. (optional) Cut off a release branch named `release-<major>.<minor>` on the tagged commit **ONLY** when releasing a new minor version.
 
 ### Release
-1. Make a fresh clone of the [repo](https://github.com/oras-project/oras) after all above steps are completed. Create a new tag for the version prefixed with "v" and push the tag directly to the repo. The tag should be created on the voted commit, **NOT** the merge commit.
+1. Make a fresh clone of the [repository](https://github.com/oras-project/oras) after all above steps are completed. Create a new tag for the version prefixed with "v" and push the tag directly to the repository. The tag should be created on the voted commit, **NOT** the merge commit.
     ```sh
     version=1.0.0
     digest=b58e7b910ca556973d111e9bd734a71baef03db2 # replace with the digest of the voted commit

diff --git a/community/reporting_security_concerns.mdx b/community/reporting_security_concerns.mdx
@@ -14,7 +14,7 @@ To report a security vulnerability, please follow these steps:
 
 **Step 1**
 
-Navigate to the appropriate reporsitory.
+Navigate to the appropriate repository.
 
 **Step 2**
 

diff --git a/versioned_docs/version-1.1/client_libraries/overview.mdx b/versioned_docs/version-1.1/client_libraries/overview.mdx
@@ -86,7 +86,7 @@ Hint: A [polytree](https://en.wikipedia.org/wiki/Polytree) is a DAG.
 
 🚧 *Note: this section is contingent on
 [oras-project/oras-go#8](https://github.com/oras-project/oras-go/pull/8) and
-does not reprersent the current state of the ORAS Go client library.*
+does not represent the current state of the ORAS Go client library.*
 
 At a high-level, each client library provides the concept of a `Target` interface
 and a `Copy` method. `Copy` transfers content from one `Target` to another.

diff --git a/versioned_docs/version-1.1/commands/oras_completion_bash.mdx b/versioned_docs/version-1.1/commands/oras_completion_bash.mdx
@@ -7,7 +7,7 @@ sidebar_position: 44
 
 Generate the autocompletion script for the bash shell.
 This script depends on the 'bash-completion' package.
-If it is not installed already, you can install it via your operationg system package manager.
+If it is not installed already, you can install it via your operating system package manager.
 To load completions in your current shell session:
 ```bash
 	source <(oras completion bash)

diff --git a/versioned_docs/version-1.1/compatible_oci_registries.mdx b/versioned_docs/version-1.1/compatible_oci_registries.mdx
@@ -182,7 +182,7 @@ Then you can pull files from the registry or push files to the registry.
 
 ### [Amazon Elastic Container Registry (ECR)](https://aws.amazon.com/ecr/)
 
-ECR Artifact Blog Post: [OCI Arfifact Support in Amazon ECR](https://aws.amazon.com/blogs/containers/oci-artifact-support-in-amazon-ecr/)
+ECR Artifact Blog Post: [OCI Artifact Support in Amazon ECR](https://aws.amazon.com/blogs/containers/oci-artifact-support-in-amazon-ecr/)
 
 - Authenticating with ECR using the AWS CLI
   ```

diff --git a/versioned_docs/version-1.1/concepts/artifact.mdx b/versioned_docs/version-1.1/concepts/artifact.mdx
@@ -30,7 +30,7 @@ should be assumed to be immutable where as the tag may be mutable.
 A *tag* resolves to a data structure called the [descriptor][descriptor] which
 contains the digest of the manifest or index.
 
-![Diagram showing relationship and fiels of a tag image and index](/img/concepts/artifact/tag_relations.png)
+![Diagram showing relationship and fields of a tag image and index](/img/concepts/artifact/tag_relations.png)
 
 ### The Significance of Annotations
 

diff --git a/versioned_docs/version-1.1/concepts/reference.mdx b/versioned_docs/version-1.1/concepts/reference.mdx
@@ -41,7 +41,7 @@ you want to pull or push.
 
 - **Tag**: Tags are user-friendly references to specific image or artifact versions.
 Common tags include `latest`, `v1.0`,
-or any other description that makes sense for versioning or identiying and resolve to a digest.
+or any other description that makes sense for versioning or identifying and resolve to a digest.
 These are typically human readable and easy to remember.
 
 ![Diagram showing example of by tag reference](/img/concepts/reference/by_tag.png)

diff --git a/versioned_docs/version-1.1/concepts/reftypes.mdx b/versioned_docs/version-1.1/concepts/reftypes.mdx
@@ -27,7 +27,7 @@ A reference type enables an OCI artifact to refer to another, creating a defined
 link or association between them. This association can be for various purposes,
 such as versioning, supply chain artifacts (signatures, SBOM, etc.), and dependencies.
 
-![OCI artifact with refererrs pointing to the artifact](/img/concepts/reftypes.png)
+![OCI artifact with referrers pointing to the artifact](/img/concepts/reftypes.png)
 
 ## Creating a Reference Artifact
 
@@ -63,7 +63,7 @@ The association is now established in the registry.
 
 :::tip NOTE
 The specification does allow  pushing the reference artifact **without** requiring 
-the presense of the the `subject` in the target registry or OCI-Layout. 
+the presence of the `subject` in the target registry or OCI-Layout. 
 :::
 
 The following example shows the manifest of Artifact B with a reference to Artifact A 
@@ -134,8 +134,8 @@ of a certain media type from the registry, which then responds with the filtered
 The response will include the `OCI-Filters-Applied: artifactType` header to indicate
 that the response is filtered by the `artifactType` query parameter.
 
-The artifact type is determied by the same rules as per 
-[OCI artifacts guidlines](artifact.mdx#determining-the-artifact-type).
+The artifact type is determined by the same rules as per 
+[OCI artifacts guidelines](artifact.mdx#determining-the-artifact-type).
 
 ```mermaid
 sequenceDiagram

diff --git a/versioned_docs/version-1.1/how_to_guides/manifest_annotations.mdx b/versioned_docs/version-1.1/how_to_guides/manifest_annotations.mdx
@@ -42,7 +42,7 @@ Digest: sha256:fae55c9d8640525a49d7ac18a36390e2cdc2742c68d68487882703f22df69ae7
 
 ### Make Annotations File
 
-Users can make annotations to the manifest, the config, and individual files (i.e. layers) by the `--annotation-file file` option if they would like to do so using a a `.json` file.
+Users can make annotations to the manifest, the config, and individual files (i.e. layers) by the `--annotation-file file` option if they would like to do so using a `.json` file.
 
 The annotations file is a JSON file with the following format:
 

diff --git a/versioned_docs/version-1.1/how_to_guides/pushing_and_pulling.mdx b/versioned_docs/version-1.1/how_to_guides/pushing_and_pulling.mdx
@@ -147,7 +147,7 @@ oras pull localhost:5000/hello-artifact:v2
 ## Using cache when pulling artifacts
 
 ORAS pulls the artifact into a content-addressable storage (CAS) cache if the content is not available locally to save bandwidth and disk I/O.
-Once the content is availabe in the cache, ORAS copies the artifact to the desired location. 
+Once the content is available in the cache, ORAS copies the artifact to the desired location. 
 The cache directory is specified by using the environment variable `ORAS_CACHE`. If not specified, cache is not used.
 
 ```

diff --git a/versioned_docs/version-1.2/client_libraries/overview.mdx b/versioned_docs/version-1.2/client_libraries/overview.mdx
@@ -86,7 +86,7 @@ Hint: A [polytree](https://en.wikipedia.org/wiki/Polytree) is a DAG.
 
 🚧 *Note: this section is contingent on
 [oras-project/oras-go#8](https://github.com/oras-project/oras-go/pull/8) and
-does not reprersent the current state of the ORAS Go client library.*
+does not represent the current state of the ORAS Go client library.*
 
 At a high-level, each client library provides the concept of a `Target` interface
 and a `Copy` method. `Copy` transfers content from one `Target` to another.

diff --git a/versioned_docs/version-1.2/commands/oras_completion_bash.mdx b/versioned_docs/version-1.2/commands/oras_completion_bash.mdx
@@ -7,7 +7,7 @@ sidebar_position: 44
 
 Generate the autocompletion script for the bash shell.
 This script depends on the 'bash-completion' package.
-If it is not installed already, you can install it via your operationg system package manager.
+If it is not installed already, you can install it via your operating system package manager.
 To load completions in your current shell session:
 ```bash
 	source <(oras completion bash)

diff --git a/versioned_docs/version-1.2/compatible_oci_registries.mdx b/versioned_docs/version-1.2/compatible_oci_registries.mdx
@@ -183,7 +183,7 @@ Then you can pull files from the registry or push files to the registry.
 
 ### [Amazon Elastic Container Registry (ECR)](https://aws.amazon.com/ecr/)
 
-ECR Artifact Blog Post: [OCI Arfifact Support in Amazon ECR](https://aws.amazon.com/blogs/containers/oci-artifact-support-in-amazon-ecr/)
+ECR Artifact Blog Post: [OCI Artifact Support in Amazon ECR](https://aws.amazon.com/blogs/containers/oci-artifact-support-in-amazon-ecr/)
 
 - Authenticating with ECR using the AWS CLI
   ```

diff --git a/versioned_docs/version-1.2/concepts/artifact.mdx b/versioned_docs/version-1.2/concepts/artifact.mdx
@@ -30,7 +30,7 @@ should be assumed to be immutable where as the tag may be mutable.
 A *tag* resolves to a data structure called the [descriptor][descriptor] which
 contains the digest of the manifest or index.
 
-![Diagram showing relationship and fiels of a tag image and index](/img/concepts/artifact/tag_relations.png)
+![Diagram showing relationship and fields of a tag image and index](/img/concepts/artifact/tag_relations.png)
 
 ### The Significance of Annotations
 

diff --git a/versioned_docs/version-1.2/concepts/reference.mdx b/versioned_docs/version-1.2/concepts/reference.mdx
@@ -41,7 +41,7 @@ you want to pull or push.
 
 - **Tag**: Tags are user-friendly references to specific image or artifact versions.
 Common tags include `latest`, `v1.0`,
-or any other description that makes sense for versioning or identiying and resolve to a digest.
+or any other description that makes sense for versioning or identifying and resolve to a digest.
 These are typically human readable and easy to remember.
 
 ![Diagram showing example of by tag reference](/img/concepts/reference/by_tag.png)

diff --git a/versioned_docs/version-1.2/concepts/reftypes.mdx b/versioned_docs/version-1.2/concepts/reftypes.mdx
@@ -27,7 +27,7 @@ A reference type enables an OCI artifact to refer to another, creating a defined
 link or association between them. This association can be for various purposes,
 such as versioning, supply chain artifacts (signatures, SBOM, etc.), and dependencies.
 
-![OCI artifact with refererrs pointing to the artifact](/img/concepts/reftypes.png)
+![OCI artifact with referrers pointing to the artifact](/img/concepts/reftypes.png)
 
 ## Creating a Reference Artifact
 
@@ -63,7 +63,7 @@ The association is now established in the registry.
 
 :::tip NOTE
 The specification does allow  pushing the reference artifact **without** requiring 
-the presense of the the `subject` in the target registry or OCI-Layout. 
+the presence of the `subject` in the target registry or OCI-Layout. 
 :::
 
 The following example shows the manifest of Artifact B with a reference to Artifact A 
@@ -134,8 +134,8 @@ of a certain media type from the registry, which then responds with the filtered
 The response will include the `OCI-Filters-Applied: artifactType` header to indicate
 that the response is filtered by the `artifactType` query parameter.
 
-The artifact type is determied by the same rules as per 
-[OCI artifacts guidlines](artifact.mdx#determining-the-artifact-type).
+The artifact type is determined by the same rules as per 
+[OCI artifacts guidelines](artifact.mdx#determining-the-artifact-type).
 
 ```mermaid
 sequenceDiagram

diff --git a/versioned_docs/version-1.2/how_to_guides/manifest_annotations.mdx b/versioned_docs/version-1.2/how_to_guides/manifest_annotations.mdx
@@ -42,7 +42,7 @@ Digest: sha256:fae55c9d8640525a49d7ac18a36390e2cdc2742c68d68487882703f22df69ae7
 
 ### Make Annotations File
 
-Users can make annotations to the manifest, the config, and individual files (i.e. layers) by the `--annotation-file file` option if they would like to do so using a a `.json` file.
+Users can make annotations to the manifest, the config, and individual files (i.e. layers) by the `--annotation-file file` option if they would like to do so using a `.json` file.
 
 The annotations file is a JSON file with the following format:
 

diff --git a/versioned_docs/version-1.2/how_to_guides/pushing_and_pulling.mdx b/versioned_docs/version-1.2/how_to_guides/pushing_and_pulling.mdx
@@ -147,7 +147,7 @@ oras pull localhost:5000/hello-artifact:v2
 ## Using cache when pulling artifacts
 
 ORAS pulls the artifact into a content-addressable storage (CAS) cache if the content is not available locally to save bandwidth and disk I/O.
-Once the content is availabe in the cache, ORAS copies the artifact to the desired location. 
+Once the content is available in the cache, ORAS copies the artifact to the desired location. 
 The cache directory is specified by using the environment variable `ORAS_CACHE`. If not specified, cache is not used.
 
 ```

diff --git a/versioned_docs/version-1.2/how_to_guides/remote_registries.mdx b/versioned_docs/version-1.2/how_to_guides/remote_registries.mdx
@@ -13,7 +13,7 @@ You may also experiment with ORAS using a [local container registry](/quickstart
 
 ## Authentication
 
-Most remote registry will require you to authenticte before you can push or pull artifacts.
+Most remote registry will require you to authenticate before you can push or pull artifacts.
 The [`oras login`](/commands/oras_login.mdx) command is used for authentication.
 
 On GHCR, you can get an authentication token by going to user Settings, Developer Settings,