From 86f3f26a18f2aaf4de6b73047be1f2cb51b81c4d Mon Sep 17 00:00:00 2001 From: Jim Tittsler Date: Sat, 15 Jan 2022 16:32:52 +0900 Subject: [PATCH] Fix typos --- README.md | 6 +++--- docs/running-headscale-linux.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 07da4aab..9a599d3d 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ To contribute to Headscale you would need the lastest version of [Go](https://go ### Code style -To ensure we have some consistency with a growing number of contributes, this project has adopted linting and style/formatting rules: +To ensure we have some consistency with a growing number of contributions, this project has adopted linting and style/formatting rules: The **Go** code is linted with [`golangci-lint`](https://golangci-lint.run) and formatted with [`golines`](https://github.com/segmentio/golines) (width 88) and @@ -76,7 +76,7 @@ run `make lint` and `make fmt` before committing any code. The **Proto** code is linted with [`buf`](https://docs.buf.build/lint/overview) and formatted with [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html). -The **rest** (markdown, yaml, etc) is formatted with [`prettier`](https://prettier.io). +The **rest** (Markdown, YAML, etc) is formatted with [`prettier`](https://prettier.io). Check out the `.golangci.yaml` and `Makefile` to see the specific configuration. @@ -92,7 +92,7 @@ make install-protobuf-plugins ### Testing and building -Some parts of the project requires the generation of Go code from Protobuf (if changes is made in `proto/`) and it must be (re-)generated with: +Some parts of the project require the generation of Go code from Protobuf (if changes are made in `proto/`) and it must be (re-)generated with: ```shell make generate diff --git a/docs/running-headscale-linux.md b/docs/running-headscale-linux.md index d53b72f8..7a62fcc6 100644 --- a/docs/running-headscale-linux.md +++ b/docs/running-headscale-linux.md @@ -21,7 +21,7 @@ wget --output-document=/usr/local/bin/headscale \ chmod +x /usr/local/bin/headscale ``` -3. Prepare a direction to hold `headscale` configuration and the [SQLite](https://www.sqlite.org/) database: +3. Prepare a directory to hold `headscale` configuration and the [SQLite](https://www.sqlite.org/) database: ```shell # Directory for configuration @@ -32,7 +32,7 @@ mkdir -p /etc/headscale mkdir -p /var/lib/headscale ``` -4. Create an empty SQlite datebase: +4. Create an empty SQLite database: ```shell touch /var/lib/headscale/db.sqlite @@ -106,7 +106,7 @@ tailscale up --login-server --authkey ## Running `headscale` in the background with SystemD -In this section it will be demonstrated how to run `headscale` as a service in the background with [SystemD](https://www.freedesktop.org/wiki/Software/systemd/). +This section demonstrates how to run `headscale` as a service in the background with [SystemD](https://www.freedesktop.org/wiki/Software/systemd/). This should work on most modern Linux distributions. 1. Create a SystemD service configuration at `/etc/systemd/system/headscale.service` containing: