From f4775bf0a2be77a81dc41a12861eaf8cc62d41ff Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Sun, 15 Jan 2023 15:00:42 +0100 Subject: [PATCH 1/3] Fix: typos Fix: typos --- docs/src/security.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/security.md b/docs/src/security.md index b2dae3c..1123b68 100644 --- a/docs/src/security.md +++ b/docs/src/security.md @@ -75,11 +75,11 @@ valist threshold [org-name]/[repo-name] [threshold-number] ## Voting on Access Control & Releases -After a repository or organization's threshold it set to a number greater than **1**, all operations will require the target number of votes before they are finalized. +After a repository or organization's threshold is set to a number greater than **1**, all operations will require the target number of votes before they are finalized. ## Considerations -* By design the repository threshold can only be set to a maximum of `n-1`. This it to create a permanent buffer of 1 key so that by default if members misplace a key they do not loose access to their organization or repository. +* By design the repository threshold can only be set to a maximum of `n-1`. This is to create a permanent buffer of 1 key so that by default if members misplace a key they do not lose access to their organization or repository. * When revoking a key from an organization or repository if the number of remaining keys is equal to the current threshold then the threshold will be automatically decreased by one. From b9445892d1c4393e9aa0b0424b4dbc84755a5567 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Sun, 15 Jan 2023 15:01:46 +0100 Subject: [PATCH 2/3] Fix: typos Fix: typos --- docs/src/repositories.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/repositories.md b/docs/src/repositories.md index 9e67d2b..1b050f2 100644 --- a/docs/src/repositories.md +++ b/docs/src/repositories.md @@ -1,12 +1,12 @@ # Repositories -After you have created an organization, you are ready to create a repository. Creating a repository allows you to mange, publish, and retrieve your software releases on Valist. +After you have created an organization, you are ready to create a repository. Creating a repository allows you to manage, publish, and retrieve your software releases on Valist. If you have not created an organization yet, don't worry -- creating a repository will automatically prompt you to create the parent organization if it doesn't exist. ## CLI -To create a new repository on from the CLI, call `valist create` and pass it your `organization` and `repository name`. +To create a new repository from the CLI, call `valist create` and pass it your `organization` and `repository name`. ```bash valist create [org-name]/[repo-name] From 31cfb04c39cb7b9e1b8ccb196d4a0214647c5860 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Sun, 15 Jan 2023 15:02:51 +0100 Subject: [PATCH 3/3] Fix: typos Fix: typos --- docs/src/publishing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/publishing.md b/docs/src/publishing.md index b6b2bc7..67a4989 100644 --- a/docs/src/publishing.md +++ b/docs/src/publishing.md @@ -165,7 +165,7 @@ artifacts: windows/amd64: dist/windows64 ``` -Now naviagate to [https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) and set the `VALIST_SIGNER` secret for your reposiotry as your chosen private key. +Now navigate to [https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) and set the `VALIST_SIGNER` secret for your repository as your chosen private key. Running the following commands in your project will commit and push triggering a new publish: @@ -175,4 +175,4 @@ git commit -m "Release 0.0.1" git push ``` -The Valist CLI inside the Github Action will publish the artifacts to the corresponding `name`, and `tag`. \ No newline at end of file +The Valist CLI inside the Github Action will publish the artifacts to the corresponding `name`, and `tag`.