Skip to content
This repository was archived by the owner on Mar 16, 2024. It is now read-only.

Commit fadb607

Browse files
small typo fixes (#1528)
Signed-off-by: jacobdonenfeld <jedonenfeld@gmail.com>
1 parent 1343d98 commit fadb607

40 files changed

+55
-55
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ When your PR is ready for review and merging, ensure your commit messages and st
2727

2828
Regarding the commit message: follow best practices. Here are two good resources for writing good commit messages:
2929
- [How to Write a Git Commit Message](https://cbea.ms/git-commit/)
30-
- [Git-scm.com's "Commit guildelines"](ttps://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines)
30+
- [Git-scm.com's "Commit guidelines"](ttps://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines)
3131

3232
From the first resource, here are the seven rules of a great commit message:
3333

docs/docs/100-reference/02-admin/03-computeclasses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,6 @@ affinity: # The same affinity fields for Pods
4141
If `memory.min`, `memory.max`, `memory.values`, `affinity`, and `tolerations` are not given, then there are no scheduling rules for workloads using the compute class.
4242

4343
## Cluster Compute Classes
44-
Cluster Compute Classes are exactly the same as Project Compute Classes except that they are not namespaced. This means that Cluster Woerkload Classes are available to every app running in your cluster.
44+
Cluster Compute Classes are exactly the same as Project Compute Classes except that they are not namespaced. This means that Cluster Workload Classes are available to every app running in your cluster.
4545

4646
Similar to Project Compute Classes, there can be only one default for the entire cluster. However, there can be a default Cluster Compute Class and a default Project Compute Class for any project; the Project Compute Class default will take precedence in this situation. Similarly, if a Cluster Compute Class and a Project Compute Class exist with the same name, then the Project Compute Class will take precedence. These rules are applied when deploying apps and also when using the [`acorn offerings volumeclasses`](100-reference/01-command-line/acorn_offerings_computeclasses.md) command.

docs/docs/100-reference/03-acornfile.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ containers: db: {
255255
`ports` defines which ports are available on the container and the default level of access. Ports
256256
are defined with three different access modes: internal, expose, publish. Internal ports are only available
257257
to the containers within an Acorn. Expose(d) ports are available to services within the cluster. And
258-
publish ports are available publically outside the cluster. The access mode defined in the Acornfile is
258+
publish ports are available publicly outside the cluster. The access mode defined in the Acornfile is
259259
just the default behavior and can be changed at deploy time.
260260
```acorn
261261
containers: web: {
@@ -450,7 +450,7 @@ containers: web: {
450450
```
451451

452452
### memory
453-
`memory` allows you to specify how much memory the container should run with. It can be abreviated to `mem`. If left unspecified, it will be defaulted to the installation default (see the [reference documentation for memory](06-compute-resources.md#memory) for more information).
453+
`memory` allows you to specify how much memory the container should run with. It can be abbreviated to `mem`. If left unspecified, it will be defaulted to the installation default (see the [reference documentation for memory](06-compute-resources.md#memory) for more information).
454454

455455
```acorn
456456
containers: {
@@ -676,7 +676,7 @@ secrets: "my-token": {
676676
}
677677
```
678678
### data
679-
`data` defines the keys and non-senstive values that will be used by the secret.
679+
`data` defines the keys and non-sensitive values that will be used by the secret.
680680
Refer to [the secrets documentation](38-authoring/05-secrets.md) for
681681
descriptions of the different secret types and how to use data keys and values.
682682

@@ -701,7 +701,7 @@ secrets: {
701701

702702
## args
703703

704-
`args` defines arguements that can be modified at build or runtime by the user.
704+
`args` defines arguments that can be modified at build or runtime by the user.
705705
Arguments to an Acorn can be standard strings, ints, bools, and other complex types. To define an argument,
706706
specify a name and a default value. The type will be inferred from the default value.
707707

docs/docs/100-reference/06-compute-resources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ You can configure Acorn apps to have a set compute class upon startup.
5050

5151
Setting a compute class allows you to define what the infrastructure providing your Acorn workloads should look like. Things that compute classes control include:
5252

53-
- What OS/Architecure your workloads will run on
53+
- What OS/Architecture your workloads will run on
5454
- How much memory is minimal, maximal, default and allowed
5555
- How many vCPUs should be allocated
5656

@@ -78,7 +78,7 @@ Breaking this down:
7878
1. `-` denotes a range and any value within it can be specified.
7979
2. `,` denotes specific values that are the only ones allowed.
8080

81-
Specifying compute classes can be done in the Acornfile (using the [class property](03-acornfile.md#class) for containers) or at runtime (using the [--compute-class flag](50-running/55-compute-resources.md#compute-class)). If you do not specify a compute class, the default compute class for the project will be used. If there is no default for the project, the default for the cluster will be used. Finally, if there is no cluster default then no compute class will be used. Depending on the compute class that is used, the memory that you specify may be in contention with its requirements. Should that happen Acorn will provide a descriptive error message to ammend any issues.
81+
Specifying compute classes can be done in the Acornfile (using the [class property](03-acornfile.md#class) for containers) or at runtime (using the [--compute-class flag](50-running/55-compute-resources.md#compute-class)). If you do not specify a compute class, the default compute class for the project will be used. If there is no default for the project, the default for the cluster will be used. Finally, if there is no cluster default then no compute class will be used. Depending on the compute class that is used, the memory that you specify may be in contention with its requirements. Should that happen Acorn will provide a descriptive error message to amend any issues.
8282

8383
:::note
8484
Looking to manage a compute class? This should only be done if you are (or are in communication with) an administrator of Acorn. You can read more information about managing compute classes [here](02-admin/03-computeclasses.md)

docs/docs/38-authoring/00-overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ localData: {
113113

114114
Strings can be a single line or multiline. A single line string is surrounded by `"` quotes.
115115

116-
Multiline strings are enclosed in triple quotes `"""`. The opening `"""` must be followed by a newline. The closing `"""` must also be on it's own line. The whitespace directly preceding the closing quotles must match the preceding whitespace on all other lines and is not included in the value. This allows you to indent the text to match current level without the indenting becoming part of the actual value.
116+
Multiline strings are enclosed in triple quotes `"""`. The opening `"""` must be followed by a newline. The closing `"""` must also be on it's own line. The whitespace directly preceding the closing quotes must match the preceding whitespace on all other lines and is not included in the value. This allows you to indent the text to match current level without the indenting becoming part of the actual value.
117117

118118
```acorn
119119
singleLine: "Hi!"
@@ -278,10 +278,10 @@ All the basic math and comparison operators you'd find in a typical programming
278278
| :--------|:--------|:--------|:-------|
279279
| Addition | `+` | `1 + 1` | `2` |
280280
| Subtraction | `-` | `4 - 1` | `3` |
281-
| Muliplication | `*` | `4 * 2` | `8` |
281+
| Multiplication | `*` | `4 * 2` | `8` |
282282
| Division | `/` | `5 / 2` | `2.5`|
283283
| Greater than | `>` | `2 > 1` | `true` |
284-
| Grather than or equal | `>=` | `2 >= 2` | `true` |
284+
| Greater than or equal | `>=` | `2 >= 2` | `true` |
285285
| Less than | `<` | `1 < 1` | `false` |
286286
| Less than or equal | `<=` | `1 <= 1` | `true` |
287287
| Equals | `==` | `1 == 2` | `false` |
@@ -363,7 +363,7 @@ containers: {
363363
}
364364
```
365365

366-
See the [function libarary](../reference/functions#ifelse) for more information.
366+
See the [function library](../reference/functions#ifelse) for more information.
367367

368368
## For loops
369369

docs/docs/38-authoring/03-containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ The `memory` property can be abbreviated to `mem` in the file.
363363

364364
## Compute Classes
365365

366-
When you want to specify what infrastructure your Acorn's workload will run on, you use Compute Classes. You can set the class of a workload by defining by the `class` property defineable on all workloads (`containers` and `jobs`). Check out the [compute class documemtation](100-reference/06-compute-resources.md#compute-classes) for more information.
366+
When you want to specify what infrastructure your Acorn's workload will run on, you use Compute Classes. You can set the class of a workload by defining by the `class` property definable on all workloads (`containers` and `jobs`). Check out the [compute class documentation](100-reference/06-compute-resources.md#compute-classes) for more information.
367367

368368
```acorn
369369
containers: {

docs/docs/38-authoring/05-secrets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Acorn makes multiple types of secrets available to the Acorn author.
120120
1. **Template:** Used to store configuration files that contain sensitive information.
121121
1. **Token:** Used to generate and/or store long secret strings.
122122
1. **Generated:** Used to take the output of a `job` and pass along as a secret bit of info.
123-
1. **Opaque:** A generic secret that can store defaults in the Acorn, or is meant to be overriden by the user to pass unknown/unstructured sensitive data.
123+
1. **Opaque:** A generic secret that can store defaults in the Acorn, or is meant to be overridden by the user to pass unknown/unstructured sensitive data.
124124

125125
### Basic secrets
126126

docs/docs/38-authoring/09-permissions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Physically defining the permissions of your application, `rules` get converted i
6565
Similar to `rules`, `clusterRules` define permissions in the application's namespace but with the added benefit of working in other ones as well. Instead of creating a `Role` that gets attached to your application's `ServiceAccount`, you get a `ClusterRole`. If you would like to allow your application to perform the defined rules in any namespace on the cluster then `clusterRules` are the way to go.
6666

6767
## Verbs
68-
To define what actions your application can perform on a given resource, you define a `verb`. These `verbs` are words that allow you to declaritively define what actions your application can perform on given resources.
68+
To define what actions your application can perform on a given resource, you define a `verb`. These `verbs` are words that allow you to declaratively define what actions your application can perform on given resources.
6969

7070
:::info
7171
Wondering what verbs are available? Take a look!

docs/docs/39-publishing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ acorn login index.docker.io
5555
acorn login ghcr.io
5656
```
5757

58-
You will be prompted for your username and password to login. If your company has an internal registry you can login subtituting `ghcr.io` for your organizations registry domain.
58+
You will be prompted for your username and password to login. If your company has an internal registry you can login substituting `ghcr.io` for your organizations registry domain.
5959

6060
### Push the image
6161

docs/docs/50-running/20-labels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Labels and Annotations
33
---
44

5-
As mentioned in the [authoring section](38-authoring/20-labels.md), you can add labels and annotations to your Acorns that will then be propogated down to the core Kubernetes resources created by Acorn. Authors of Acorn images can add these directly to the Acornfile, but users can also add them at runtime.
5+
As mentioned in the [authoring section](38-authoring/20-labels.md), you can add labels and annotations to your Acorns that will then be propagated down to the core Kubernetes resources created by Acorn. Authors of Acorn images can add these directly to the Acornfile, but users can also add them at runtime.
66

77
The flags for adding labels and annotations allow you to specify the resource type and name you are targeting. This is best explained through examples:
88

0 commit comments

Comments
 (0)