diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7834ab921..bf3d15b76 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ Let's talk about some of the guidelines we have when making a contribution to Ta ### Git Commits -You probably noticed we use have a funny way of writing commit messages. +You probably noticed we use a funny way of writing commit messages. Indeed we do, but its based on a specification called [Conventional Commits](https://www.conventionalcommits.org). Don't worry, it won't be _too_ much of hassle. We have a small tool that you can use to remind you of our policy. @@ -58,7 +58,7 @@ In the `Makefile` there are a variety of targets, the most common are: * `kernel` creates the `vmlinuz` Linux kernel executable. * `initamfs` creates the `initramfs.xz` initial RAMdisk filesystem. * `image-vanilla` creates the `image.raw` file that can be used as a image volume for VMs. -* `osctl-linux-amd64` and `osctl-darwin-amd64` make the `osctl` CLI tool for Linux & OSX respectivly. +* `osctl-linux-amd64` and `osctl-darwin-amd64` make the `osctl` CLI tool for Linux & OSX respectively. * `rootfs` creates an archive of the root filesystem preloaded with all the components needed to launch Talos & Kubernetes. # Buildkit diff --git a/README.md b/README.md index db2abbf60..6aca81dae 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ For instructions on deploying and managing Talos, see the [Documentation](https: - Twitter: [@talossystems](https://twitter.com/talossystems) - Email: [info@talos-systems.com](mailto:info@talos-systems.com) -If your interested in this project and would like to help in engineering efforts, or have general usage questions, we are happy to have you! +If you're interested in this project and would like to help in engineering efforts, or have general usage questions, we are happy to have you! We hold two weekly meetings targeted for different audiences. ### Office Hours @@ -40,7 +40,7 @@ We hold two weekly meetings targeted for different audiences. ### Maintainers and Contributors -When attending this meeting, please add yourself to the [meeting notes](https://docs.google.com/document/d/1xBhfYg2TK8gtXtaMe3ojXeDS1qRN6MJ-Wo7IjNJSCwQ/edit#) as an atendee. If you would like to discuss a specific topic, we encourage you to add it to the agenda. +When attending this meeting, please add yourself to the [meeting notes](https://docs.google.com/document/d/1xBhfYg2TK8gtXtaMe3ojXeDS1qRN6MJ-Wo7IjNJSCwQ/edit#) as an attendee. If you would like to discuss a specific topic, we encourage you to add it to the agenda. - When: Thursdays at 17:00 UTC. - Where: [zoom](https://zoom.us/j/3595189922). diff --git a/docs/content/components/osctl.md b/docs/content/components/osctl.md index 5833e9634..b92bd2e0f 100644 --- a/docs/content/components/osctl.md +++ b/docs/content/components/osctl.md @@ -15,4 +15,4 @@ menu: - `osctl dmesg` - retrieve kernel logs - `osctl ps` - view running services - `osctl top` - view node resources -- `osctl services` - view status of talos services +- `osctl services` - view status of Talos services diff --git a/docs/content/configuration/masters.md b/docs/content/configuration/masters.md index fd8c14a10..5e2f38f2c 100644 --- a/docs/content/configuration/masters.md +++ b/docs/content/configuration/masters.md @@ -49,7 +49,7 @@ Each master node participates as a Root of Trust in the cluster. The responsibilities of `trustd` include: - certificate as a service -- Kubernetes PKI distribution amongst master nodes +- Kubernetes PKI distribution among master nodes The authorization between `trustd` and a client is, for now, a simple username and password combination. Having these credentials gives a client the power to request a certificate that identifies itself. diff --git a/docs/content/configuration/userdata.md b/docs/content/configuration/userdata.md index 6a61552f6..2510210c3 100644 --- a/docs/content/configuration/userdata.md +++ b/docs/content/configuration/userdata.md @@ -151,7 +151,7 @@ OptionNTPServers ## Services ### Init -``Init`` allows for the customizatin of the CNI plugin. This translates to additional host mounts. +``Init`` allows for the customization of the CNI plugin. This translates to additional host mounts. ```yaml services: @@ -440,7 +440,7 @@ install: ### Force -``Force`` allows the partitiong to proceed if there is already a filesystem detected. +``Force`` allows the partitioning to proceed if there is already a filesystem detected. ``` install: diff --git a/docs/content/guides/getting_started.md b/docs/content/guides/getting_started.md index 040330469..b32e647cc 100644 --- a/docs/content/guides/getting_started.md +++ b/docs/content/guides/getting_started.md @@ -38,7 +38,7 @@ Once the above finishes successfully, your talosconfig(`~/.talos/config`) will b Once the cluster is available, the pod security policies will need to be applied to allow the control plane to come up. Following that, the default CNI (flannel) configuration will be applied. -### Retreive and Configure the `kubeconfig` +### Retrieve and Configure the `kubeconfig` ```bash osctl kubeconfig > kubeconfig diff --git a/docs/content/talos.md b/docs/content/talos.md index e75c56209..6de7e8877 100644 --- a/docs/content/talos.md +++ b/docs/content/talos.md @@ -16,7 +16,7 @@ menu: For details on the various components that make up Talos, please see the [components]({{< ref "/docs/components" >}}) section. -To get started with talos, see the [Getting Started Guide]({{< ref "/docs/guides/getting_started" >}}). +To get started with Talos, see the [Getting Started Guide]({{< ref "/docs/guides/getting_started" >}}). If you need help, or if you have questions or comments, we would love to hear from you! Please join our community on [Slack](https://slack.dev.talos-systems.io), [GitHub](https://github.com/talos-systems), or the mailing list.