Skip to content

Fix: typos #39

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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`.
The Valist CLI inside the Github Action will publish the artifacts to the corresponding `name`, and `tag`.
4 changes: 2 additions & 2 deletions docs/src/repositories.md
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
4 changes: 2 additions & 2 deletions docs/src/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down