From 64fb0fc99b32923933d72dcf7932934c64fb3766 Mon Sep 17 00:00:00 2001 From: Ben Siraphob Date: Tue, 2 Sep 2025 21:47:38 -0700 Subject: [PATCH] nixos/doc: fix typos --- nixos/doc/manual/manual.md | 4 ++-- nixos/modules/services/matrix/maubot.md | 2 +- nixos/modules/services/matrix/mautrix-whatsapp.md | 2 +- nixos/modules/services/web-apps/glance.md | 2 +- nixos/modules/services/web-apps/hatsu.md | 2 +- nixos/modules/services/web-apps/lemmy.md | 4 ++-- nixos/modules/services/web-apps/ocis.md | 2 +- nixos/tests/common/acme/server/README.md | 2 +- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/nixos/doc/manual/manual.md b/nixos/doc/manual/manual.md index 8cb766eeccf6..4fc39ffc785b 100644 --- a/nixos/doc/manual/manual.md +++ b/nixos/doc/manual/manual.md @@ -7,11 +7,11 @@ the manual structure extends the nixpkgs commonmark further with include blocks to allow better organization of input text. there are six types of include blocks: preface, parts, chapters, sections, appendix, and options. - each type except `options`` corresponds to the docbook elements of (roughly) + each type except `options` corresponds to the docbook elements of (roughly) the same name, and can itself can further include blocks to denote its substructure. - non-`options`` include blocks are fenced code blocks that list a number of + non-`options` include blocks are fenced code blocks that list a number of files to include, in the form ```{=include=} diff --git a/nixos/modules/services/matrix/maubot.md b/nixos/modules/services/matrix/maubot.md index d7c02a0ca19c..b2633f793e23 100644 --- a/nixos/modules/services/matrix/maubot.md +++ b/nixos/modules/services/matrix/maubot.md @@ -100,7 +100,7 @@ framework for Matrix. url: https://matrix.example.org secret: your-very-secret-key ``` -10. Restart Maubot after editing `/var/lib/maubot/config.yaml`,and +10. Restart Maubot after editing `/var/lib/maubot/config.yaml`, and Maubot will be available at `https://matrix.example.org/_matrix/maubot`. If you want to use the `mbc` CLI, it's available using the `maubot` package (`nix-shell -p diff --git a/nixos/modules/services/matrix/mautrix-whatsapp.md b/nixos/modules/services/matrix/mautrix-whatsapp.md index a2ef973f4e60..7a589a372996 100644 --- a/nixos/modules/services/matrix/mautrix-whatsapp.md +++ b/nixos/modules/services/matrix/mautrix-whatsapp.md @@ -13,7 +13,7 @@ ::: {.warning} Mautrix-Whatsapp allows for some options like `encryption.pickle_key`, -`provisioning.shared_secret`, allow the value `generate` to be set. +`provisioning.shared_secret`, to allow the value `generate` to be set. Since the configuration file is regenerated on every start of the service, the generated values would be discarded and might break your installation. Instead, set those values via diff --git a/nixos/modules/services/web-apps/glance.md b/nixos/modules/services/web-apps/glance.md index f65b32b3ba91..c42cd833bef3 100644 --- a/nixos/modules/services/web-apps/glance.md +++ b/nixos/modules/services/web-apps/glance.md @@ -7,7 +7,7 @@ more about it. ## Quickstart {#module-services-glance-quickstart} -Checkout the [configuration docs](https://github.com/glanceapp/glance/blob/main/docs/configuration.md) to learn more. +Check out the [configuration docs](https://github.com/glanceapp/glance/blob/main/docs/configuration.md) to learn more. Use the following configuration to start a public instance of Glance locally: ```nix diff --git a/nixos/modules/services/web-apps/hatsu.md b/nixos/modules/services/web-apps/hatsu.md index e2c61d00f121..776b80dddc11 100644 --- a/nixos/modules/services/web-apps/hatsu.md +++ b/nixos/modules/services/web-apps/hatsu.md @@ -4,7 +4,7 @@ ## Quickstart {#module-services-hatsu-quickstart} -the minimum configuration to start hatsu server would look like this: +The minimum configuration to start hatsu server would look like this: ```nix { diff --git a/nixos/modules/services/web-apps/lemmy.md b/nixos/modules/services/web-apps/lemmy.md index 0ed23607d00b..a3924448ceb5 100644 --- a/nixos/modules/services/web-apps/lemmy.md +++ b/nixos/modules/services/web-apps/lemmy.md @@ -4,7 +4,7 @@ Lemmy is a federated alternative to reddit in rust. ## Quickstart {#module-services-lemmy-quickstart} -the minimum to start lemmy is +The minimum to start lemmy is ```nix { @@ -19,7 +19,7 @@ the minimum to start lemmy is } ``` -this will start the backend on port 8536 and the frontend on port 1234. +This will start the backend on port 8536 and the frontend on port 1234. It will expose your instance with a caddy reverse proxy to the hostname you've provided. Postgres will be initialized on that same instance automatically. diff --git a/nixos/modules/services/web-apps/ocis.md b/nixos/modules/services/web-apps/ocis.md index 43ddd3175c7d..9414567604b0 100644 --- a/nixos/modules/services/web-apps/ocis.md +++ b/nixos/modules/services/web-apps/ocis.md @@ -33,7 +33,7 @@ A very basic configuration may look like this: This will start the oCIS server and make it available at `https://localhost:9200` -However to make this configuration work you will need generate a configuration. +However, to make this configuration work, you will need to generate a configuration. You can do this with: ```console diff --git a/nixos/tests/common/acme/server/README.md b/nixos/tests/common/acme/server/README.md index 9de2b2c71029..5be95a9a599c 100644 --- a/nixos/tests/common/acme/server/README.md +++ b/nixos/tests/common/acme/server/README.md @@ -5,7 +5,7 @@ to serve ACME certificate requests. ## "Snake oil" certs -The snake oil certs are hard coded into the repo for reasons explained [here](https://github.com/NixOS/nixpkgs/pull/91121#discussion_r505410235). +The snake oil certs are hard-coded into the repo for reasons explained [here](https://github.com/NixOS/nixpkgs/pull/91121#discussion_r505410235). The root of the issue is that Nix will hash the derivation based on the arguments to mkDerivation, not the output. [Minica](https://github.com/jsha/minica) will always generate a random certificate even if the arguments are unchanged. As a