From 23ea73b4169d68c0d22c3d9aed6e2a692a793ff5 Mon Sep 17 00:00:00 2001 From: pennae Date: Wed, 4 Jan 2023 06:56:24 +0100 Subject: [PATCH] nixos/manual: enable smart quotes for all MD chapters --- nixos/modules/i18n/input-method/default.nix | 2 +- nixos/modules/i18n/input-method/default.xml | 8 +-- .../programs/digitalbitbox/default.nix | 2 +- nixos/modules/programs/plotinus.nix | 2 +- nixos/modules/programs/zsh/oh-my-zsh.nix | 2 +- nixos/modules/programs/zsh/oh-my-zsh.xml | 4 +- nixos/modules/security/acme/default.nix | 2 +- nixos/modules/security/acme/doc.xml | 27 +++++----- nixos/modules/services/backup/borgbackup.nix | 2 +- nixos/modules/services/backup/borgbackup.xml | 2 +- .../services/databases/foundationdb.nix | 2 +- .../services/databases/foundationdb.xml | 16 +++--- .../modules/services/databases/postgresql.nix | 2 +- .../modules/services/databases/postgresql.xml | 8 +-- nixos/modules/services/editors/emacs.nix | 2 +- nixos/modules/services/hardware/trezord.nix | 2 +- nixos/modules/services/mail/mailman.nix | 2 +- nixos/modules/services/mail/mailman.xml | 4 +- nixos/modules/services/matrix/mjolnir.nix | 2 +- nixos/modules/services/matrix/mjolnir.xml | 16 +++--- nixos/modules/services/matrix/synapse.nix | 2 +- nixos/modules/services/matrix/synapse.xml | 10 ++-- nixos/modules/services/misc/gitlab.nix | 2 +- nixos/modules/services/misc/gitlab.xml | 6 +-- .../services/misc/sourcehut/default.nix | 2 +- .../services/misc/sourcehut/sourcehut.xml | 8 +-- .../services/misc/taskserver/default.nix | 2 +- .../modules/services/misc/taskserver/doc.xml | 8 +-- .../monitoring/prometheus/exporters.nix | 2 +- .../monitoring/prometheus/exporters.xml | 10 ++-- .../litestream/default.nix | 2 +- .../litestream/litestream.xml | 2 +- nixos/modules/services/networking/pleroma.nix | 2 +- nixos/modules/services/networking/pleroma.xml | 4 +- nixos/modules/services/networking/prosody.nix | 2 +- nixos/modules/services/networking/prosody.xml | 8 +-- .../modules/services/networking/yggdrasil.nix | 2 +- nixos/modules/services/web-apps/discourse.nix | 2 +- nixos/modules/services/web-apps/discourse.xml | 26 +++++----- nixos/modules/services/web-apps/grocy.nix | 2 +- nixos/modules/services/web-apps/grocy.xml | 2 +- .../modules/services/web-apps/jitsi-meet.nix | 2 +- .../modules/services/web-apps/jitsi-meet.xml | 2 +- nixos/modules/services/web-apps/keycloak.nix | 2 +- nixos/modules/services/web-apps/keycloak.xml | 6 +-- .../modules/services/web-apps/matomo-doc.xml | 6 +-- nixos/modules/services/web-apps/matomo.nix | 2 +- nixos/modules/services/web-apps/nextcloud.nix | 2 +- nixos/modules/services/web-apps/nextcloud.xml | 50 +++++++++---------- nixos/modules/services/web-apps/plausible.nix | 2 +- .../services/web-servers/garage-doc.xml | 20 ++++---- nixos/modules/services/web-servers/garage.nix | 2 +- .../services/x11/desktop-managers/gnome.nix | 2 +- .../x11/desktop-managers/pantheon.nix | 2 +- .../x11/desktop-managers/pantheon.xml | 10 ++-- 55 files changed, 162 insertions(+), 163 deletions(-) diff --git a/nixos/modules/i18n/input-method/default.nix b/nixos/modules/i18n/input-method/default.nix index 987e5be28330..3fa1f4c643d5 100644 --- a/nixos/modules/i18n/input-method/default.nix +++ b/nixos/modules/i18n/input-method/default.nix @@ -67,7 +67,7 @@ in meta = { maintainers = with lib.maintainers; [ ericsagnes ]; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc default.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > default.xml` + # `pandoc default.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > default.xml` doc = ./default.xml; }; diff --git a/nixos/modules/i18n/input-method/default.xml b/nixos/modules/i18n/input-method/default.xml index c6fda9a7c57d..232952119805 100644 --- a/nixos/modules/i18n/input-method/default.xml +++ b/nixos/modules/i18n/input-method/default.xml @@ -114,7 +114,7 @@ ibus.engines = with pkgs.ibus-engines; [ table table-others ]; To use any input method, the package must be added in the configuration, as shown above, and also (after running nixos-rebuild) the input method must be added - from IBus' preference dialog. + from IBus’ preference dialog.
Troubleshooting @@ -221,7 +221,7 @@ i18n.inputMethod = {
Uim - Uim (short for "universal input method") is a + Uim (short for universal input method) is a multilingual input method framework. Applications can use it through so-called bridges. @@ -244,7 +244,7 @@ i18n.inputMethod = { Hime is an extremely easy-to-use input method framework. It is lightweight, stable, powerful and supports many commonly used input methods, including Cangjie, Zhuyin, Dayi, Rank, Shrimp, - Greek, Korean Pinyin, Latin Alphabet, etc... + Greek, Korean Pinyin, Latin Alphabet, etc… The following snippet can be used to configure Hime: @@ -258,7 +258,7 @@ i18n.inputMethod = {
Kime - Kime is Korean IME. it's built with Rust language and let you get + Kime is Korean IME. it’s built with Rust language and let you get simple, safe, fast Korean typing diff --git a/nixos/modules/programs/digitalbitbox/default.nix b/nixos/modules/programs/digitalbitbox/default.nix index 38420df3d9e1..2aaa307782de 100644 --- a/nixos/modules/programs/digitalbitbox/default.nix +++ b/nixos/modules/programs/digitalbitbox/default.nix @@ -34,7 +34,7 @@ in meta = { # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart > doc.xml` + # `pandoc doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart > doc.xml` doc = ./doc.xml; maintainers = with lib.maintainers; [ vidbina ]; }; diff --git a/nixos/modules/programs/plotinus.nix b/nixos/modules/programs/plotinus.nix index 161dda576c36..3f7bbba42b9f 100644 --- a/nixos/modules/programs/plotinus.nix +++ b/nixos/modules/programs/plotinus.nix @@ -9,7 +9,7 @@ in meta = { maintainers = pkgs.plotinus.meta.maintainers; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc plotinus.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > plotinus.xml` + # `pandoc plotinus.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > plotinus.xml` doc = ./plotinus.xml; }; diff --git a/nixos/modules/programs/zsh/oh-my-zsh.nix b/nixos/modules/programs/zsh/oh-my-zsh.nix index 88b293bdfc62..7a8fd88414a6 100644 --- a/nixos/modules/programs/zsh/oh-my-zsh.nix +++ b/nixos/modules/programs/zsh/oh-my-zsh.nix @@ -143,6 +143,6 @@ in }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc oh-my-zsh.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > oh-my-zsh.xml` + # `pandoc oh-my-zsh.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > oh-my-zsh.xml` meta.doc = ./oh-my-zsh.xml; } diff --git a/nixos/modules/programs/zsh/oh-my-zsh.xml b/nixos/modules/programs/zsh/oh-my-zsh.xml index c20659e83ccd..6125ba1488ab 100644 --- a/nixos/modules/programs/zsh/oh-my-zsh.xml +++ b/nixos/modules/programs/zsh/oh-my-zsh.xml @@ -63,7 +63,7 @@ Rather than using a single mutable path for - ZSH_CUSTOM, it's also possible to generate this + ZSH_CUSTOM, it’s also possible to generate this path from a list of Nix packages: @@ -93,7 +93,7 @@
Package your own customizations - If third-party customizations (e.g. new themes) are supposed to be + If third-party customizations (e.g. new themes) are supposed to be added to oh-my-zsh there are several pitfalls to keep in mind: diff --git a/nixos/modules/security/acme/default.nix b/nixos/modules/security/acme/default.nix index 3be78084b95c..dfa3742daccc 100644 --- a/nixos/modules/security/acme/default.nix +++ b/nixos/modules/security/acme/default.nix @@ -917,7 +917,7 @@ in { meta = { maintainers = lib.teams.acme.members; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > doc.xml` + # `pandoc doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > doc.xml` doc = ./doc.xml; }; } diff --git a/nixos/modules/security/acme/doc.xml b/nixos/modules/security/acme/doc.xml index c21f802caf4b..42c73300d8b9 100644 --- a/nixos/modules/security/acme/doc.xml +++ b/nixos/modules/security/acme/doc.xml @@ -3,7 +3,7 @@ NixOS supports automatic domain validation & certificate retrieval and renewal using the ACME protocol. Any provider can be - used, but by default NixOS uses Let's Encrypt. The alternative ACME + used, but by default NixOS uses Let’s Encrypt. The alternative ACME client lego is used under the hood. @@ -17,15 +17,15 @@
Prerequisites - To use the ACME module, you must accept the provider's terms of + To use the ACME module, you must accept the provider’s terms of service by setting to - true. The Let's Encrypt ToS can be found + true. The Let’s Encrypt ToS can be found here. You must also set an email address to be used when creating - accounts with Let's Encrypt. You can set this for all certs with + accounts with Let’s Encrypt. You can set this for all certs with and/or on a per-cert basis with . This @@ -93,7 +93,7 @@ services.nginx = { Using ACME certificates with Apache virtual hosts is identical to using them with Nginx. The attribute names are all the same, just - replace "nginx" with "httpd" where + replace nginx with httpd where appropriate.
@@ -257,7 +257,7 @@ systemd.services.dns-rfc2136-conf = { }; - Now you're all set to generate certs! You should monitor the first + Now you’re all set to generate certs! You should monitor the first invocation by running systemctl start acme-example.com.service & journalctl -fu acme-example.com.service and watching its log output. @@ -270,15 +270,14 @@ systemd.services.dns-rfc2136-conf = { including those automatically configured via the Nginx/Apache enableACME option. This configuration pattern is fully supported and part of - the module's test suite for Nginx + Apache. + the module’s test suite for Nginx + Apache. You must follow the guide above on configuring DNS-01 validation first, however instead of setting the options for one certificate - (e.g. - ) - you will set them as defaults (e.g. - ). + (e.g. ) + you will set them as defaults + (e.g. ). # Configure ACME appropriately @@ -304,7 +303,7 @@ services.nginx = { } - And that's it! Next time your configuration is rebuilt, or when + And that’s it! Next time your configuration is rebuilt, or when you add a new virtualHost, it will be DNS-01 validated.
@@ -316,7 +315,7 @@ services.nginx = { are not owned by root. PostgreSQL and OpenSMTPD are examples of these. There is no way to change the user the ACME module uses (it will always be acme), however you can use - systemd's LoadCredential feature to resolve + systemd’s LoadCredential feature to resolve this elegantly. Below is an example configuration for OpenSMTPD, but this pattern can be applied to any service. @@ -360,7 +359,7 @@ in { Regenerating certificates Should you need to regenerate a particular certificate in a hurry, - such as when a vulnerability is found in Let's Encrypt, there is + such as when a vulnerability is found in Let’s Encrypt, there is now a convenient mechanism for doing so. Running systemctl clean --what=state acme-example.com.service will remove all certificate files and the account data for the diff --git a/nixos/modules/services/backup/borgbackup.nix b/nixos/modules/services/backup/borgbackup.nix index 6c79cc601c6d..bb037fc13ee6 100644 --- a/nixos/modules/services/backup/borgbackup.nix +++ b/nixos/modules/services/backup/borgbackup.nix @@ -227,7 +227,7 @@ let in { meta.maintainers = with maintainers; [ dotlambda ]; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc borgbackup.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > borgbackup.xml` + # `pandoc borgbackup.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > borgbackup.xml` meta.doc = ./borgbackup.xml; ###### interface diff --git a/nixos/modules/services/backup/borgbackup.xml b/nixos/modules/services/backup/borgbackup.xml index 26ba6b1e63c8..1c1233b11241 100644 --- a/nixos/modules/services/backup/borgbackup.xml +++ b/nixos/modules/services/backup/borgbackup.xml @@ -200,7 +200,7 @@ sudo borg init --encryption=repokey-blake2 \ protect your data from disk failure, ransomware and theft. - It can be installed in NixOS e.g. by adding + It can be installed in NixOS e.g. by adding pkgs.vorta to . diff --git a/nixos/modules/services/databases/foundationdb.nix b/nixos/modules/services/databases/foundationdb.nix index fdfe5a28f31a..0cdb832e4bc9 100644 --- a/nixos/modules/services/databases/foundationdb.nix +++ b/nixos/modules/services/databases/foundationdb.nix @@ -425,7 +425,7 @@ in }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc foundationdb.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > foundationdb.xml` + # `pandoc foundationdb.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > foundationdb.xml` meta.doc = ./foundationdb.xml; meta.maintainers = with lib.maintainers; [ thoughtpolice ]; } diff --git a/nixos/modules/services/databases/foundationdb.xml b/nixos/modules/services/databases/foundationdb.xml index ae7a6dae955e..e65458779d1b 100644 --- a/nixos/modules/services/databases/foundationdb.xml +++ b/nixos/modules/services/databases/foundationdb.xml @@ -15,7 +15,7 @@ Available version(s): 5.1.x, 5.2.x, 6.0.x - FoundationDB (or "FDB") is an open source, distributed, + FoundationDB (or FDB) is an open source, distributed, transactional key-value store.
@@ -115,8 +115,8 @@ a@link> SSD-storage based database for development and basic usage. This storage engine is designed for SSDs and will perform poorly on HDDs; however it can handle far more data than the alternative - "memory" engine and is a better default choice for most - deployments. (Note that you can change the storage backend + memory engine and is a better default choice for + most deployments. (Note that you can change the storage backend on-the-fly for a given FoundationDB cluster using fdbcli.) @@ -151,7 +151,7 @@ services.foundationdb.dataDir = "/data/fdb"; FoundationDB worker processes typically require 4GB of RAM per-process at minimum for good performance, so this option is set - to 1 by default since the maximum amount of RAM is unknown. You're + to 1 by default since the maximum amount of RAM is unknown. You’re advised to abide by this restriction, so pick a number of processes so that each has 4GB or more. @@ -282,7 +282,7 @@ fdbcli> coordinators auto FoundationDB uses a pluggable design to transport security, and out of the box it supports a LibreSSL-based plugin for TLS support. This plugin not only does in-flight encryption, but also - performs client authorization based on the given endpoint's + performs client authorization based on the given endpoint’s certificate chain. For example, a FoundationDB server may be configured to only accept client connections over TLS, where the client TLS certificate is from organization Acme @@ -303,7 +303,7 @@ fdbcli> coordinators auto After you have a key and certificate file in place, it is not - enough to simply set the NixOS module options -- you must also + enough to simply set the NixOS module options – you must also configure the fdb.cluster file to specify that a given set of coordinators use TLS. This is as simple as adding the suffix :tls to your cluster coordinator @@ -333,7 +333,7 @@ XXXXXX:XXXXXX@127.0.0.1:4500:tls However, a side effect of this is that the - fdbbackup command doesn't work properly for + fdbbackup command doesn’t work properly for local filesystem backups: FoundationDB uses a server process alongside the database processes to perform backups and copy the backups to the filesystem. As a result, this process is put under @@ -403,7 +403,7 @@ $ sudo -u foundationdb fdbbackup status -t default
Options - NixOS's FoundationDB module allows you to configure all of the + NixOS’s FoundationDB module allows you to configure all of the most relevant configuration options for fdbmonitor, matching it quite closely. A complete list of options for the FoundationDB module may be found diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix index b390199a851e..9a9a083b7c3a 100644 --- a/nixos/modules/services/databases/postgresql.nix +++ b/nixos/modules/services/databases/postgresql.nix @@ -586,7 +586,7 @@ in }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc postgresql.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > postgresql.xml` + # `pandoc postgresql.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > postgresql.xml` meta.doc = ./postgresql.xml; meta.maintainers = with lib.maintainers; [ thoughtpolice danbst ]; } diff --git a/nixos/modules/services/databases/postgresql.xml b/nixos/modules/services/databases/postgresql.xml index 4cb0dc929c68..7ca03264e366 100644 --- a/nixos/modules/services/databases/postgresql.xml +++ b/nixos/modules/services/databases/postgresql.xml @@ -23,7 +23,7 @@ services.postgresql.package = pkgs.postgresql_11; Note that you are required to specify the desired version of - PostgreSQL (e.g. pkgs.postgresql_11). Since + PostgreSQL (e.g. pkgs.postgresql_11). Since upgrading your PostgreSQL version requires a database dump and reload (see below), NixOS cannot provide a default value for such as @@ -51,7 +51,7 @@ services.postgresql.dataDir = "/data/postgresql"; Major PostgreSQL upgrades require a downtime and a few imperative steps to be called. This is the case because each major version - has some internal changes in the databases' state during major + has some internal changes in the databases’ state during major releases. Because of that, NixOS places the state into /var/lib/postgresql/<version> where each version can be obtained like this: @@ -138,7 +138,7 @@ $ nix-instantiate --eval -A postgresql_13.psqlSchema - After the upgrade it's advisable to analyze the new cluster. + After the upgrade it’s advisable to analyze the new cluster. @@ -228,7 +228,7 @@ self: super: { } - Here's a recipe on how to override a particular plugin through an + Here’s a recipe on how to override a particular plugin through an overlay: diff --git a/nixos/modules/services/editors/emacs.nix b/nixos/modules/services/editors/emacs.nix index b4f447757e76..d30fd07577c3 100644 --- a/nixos/modules/services/editors/emacs.nix +++ b/nixos/modules/services/editors/emacs.nix @@ -100,6 +100,6 @@ in }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc emacs.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > emacs.xml` + # `pandoc emacs.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > emacs.xml` meta.doc = ./emacs.xml; } diff --git a/nixos/modules/services/hardware/trezord.nix b/nixos/modules/services/hardware/trezord.nix index 014ba9164d4e..708f02fafc2a 100644 --- a/nixos/modules/services/hardware/trezord.nix +++ b/nixos/modules/services/hardware/trezord.nix @@ -9,7 +9,7 @@ in { meta = { # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc trezord.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > trezord.xml` + # `pandoc trezord.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > trezord.xml` doc = ./trezord.xml; }; diff --git a/nixos/modules/services/mail/mailman.nix b/nixos/modules/services/mail/mailman.nix index cc072505c3cf..622efd87e7b7 100644 --- a/nixos/modules/services/mail/mailman.nix +++ b/nixos/modules/services/mail/mailman.nix @@ -643,7 +643,7 @@ in { meta = { maintainers = with lib.maintainers; [ lheckemann qyliss ma27 ]; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc mailman.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > mailman.xml` + # `pandoc mailman.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > mailman.xml` doc = ./mailman.xml; }; diff --git a/nixos/modules/services/mail/mailman.xml b/nixos/modules/services/mail/mailman.xml index 115f3225333a..04f6d2020565 100644 --- a/nixos/modules/services/mail/mailman.xml +++ b/nixos/modules/services/mail/mailman.xml @@ -61,7 +61,7 @@ up, the Postorius mailing list manager and the Hyperkitty archive browser will be available at https://lists.example.org/. Note that this setup is not sufficient to deliver emails to most email - providers nor to avoid spam -- a number of additional measures for + providers nor to avoid spam – a number of additional measures for authenticating incoming and outgoing mails, such as SPF, DMARC and DKIM are necessary, but outside the scope of the Mailman module. @@ -100,7 +100,7 @@ The exim config needs some special additions to work with Mailman. - Currently NixOS can't manage Exim config with such granularity. + Currently NixOS can’t manage Exim config with such granularity. Please refer to Mailman documentation for more info on configuring Mailman for diff --git a/nixos/modules/services/matrix/mjolnir.nix b/nixos/modules/services/matrix/mjolnir.nix index 26d5914151cd..372b8ced1c21 100644 --- a/nixos/modules/services/matrix/mjolnir.nix +++ b/nixos/modules/services/matrix/mjolnir.nix @@ -237,7 +237,7 @@ in meta = { # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc mjolnir.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > mjolnir.xml` + # `pandoc mjolnir.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > mjolnir.xml` doc = ./mjolnir.xml; maintainers = with maintainers; [ jojosch ]; }; diff --git a/nixos/modules/services/matrix/mjolnir.xml b/nixos/modules/services/matrix/mjolnir.xml index 34a6767c476b..2d2d5d3d9e27 100644 --- a/nixos/modules/services/matrix/mjolnir.xml +++ b/nixos/modules/services/matrix/mjolnir.xml @@ -7,7 +7,7 @@ As an all-in-one moderation tool, it can protect your server from - malicious invites, spam messages, and whatever else you don't want. + malicious invites, spam messages, and whatever else you don’t want. In addition to server-level protection, Mjolnir is great for communities wanting to protect their rooms without having to use their personal accounts for moderation. @@ -21,7 +21,7 @@ See the README page and the - Moderator's + Moderator’s guide for additional instructions on how to setup and use Mjolnir. @@ -36,7 +36,7 @@ First create a new Room which will be used as a management room for Mjolnir. In this room, Mjolnir will log possible errors and - debugging information. You'll need to set this Room-ID in + debugging information. You’ll need to set this Room-ID in services.mjolnir.managementRoom. @@ -51,7 +51,7 @@ If you want Mjolnir to be able to deactivate users, move room - aliases, shutdown rooms, etc. you'll need to make the Mjolnir user + aliases, shutdown rooms, etc. you’ll need to make the Mjolnir user a Matrix server admin. @@ -93,10 +93,10 @@ Element Matrix Services (EMS) If you are using a managed - "Element Matrix - Services (EMS)" server, you will need to consent to - the terms and conditions. Upon startup, an error log entry with - a URL to the consent page will be generated. + Element Matrix + Services (EMS) server, you will need to consent + to the terms and conditions. Upon startup, an error log entry + with a URL to the consent page will be generated.
diff --git a/nixos/modules/services/matrix/synapse.nix b/nixos/modules/services/matrix/synapse.nix index 154b4aca7869..4f87744f8cc6 100644 --- a/nixos/modules/services/matrix/synapse.nix +++ b/nixos/modules/services/matrix/synapse.nix @@ -802,7 +802,7 @@ in { meta = { buildDocsInSandbox = false; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc synapse.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > synapse.xml` + # `pandoc synapse.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > synapse.xml` doc = ./synapse.xml; maintainers = teams.matrix.members; }; diff --git a/nixos/modules/services/matrix/synapse.xml b/nixos/modules/services/matrix/synapse.xml index 2d5eabfd11d3..822f2c324ad9 100644 --- a/nixos/modules/services/matrix/synapse.xml +++ b/nixos/modules/services/matrix/synapse.xml @@ -152,7 +152,7 @@ Success! When using , - the secret will end up in the world-readable store. Instead it's + the secret will end up in the world-readable store. Instead it’s recommended to deploy the secret in an additional file like this: @@ -173,9 +173,9 @@ registration_shared_secret: your-very-secret-secret nixops1 or sops-nix - to e.g. - /run/secrets/matrix-shared-secret and - ensure that it's readable by + to + e.g. /run/secrets/matrix-shared-secret + and ensure that it’s readable by matrix-synapse. @@ -195,7 +195,7 @@ registration_shared_secret: your-very-secret-secret - It's also possible to user alternative authentication mechanism + It’s also possible to user alternative authentication mechanism such as LDAP (via matrix-synapse-ldap3) or diff --git a/nixos/modules/services/misc/gitlab.nix b/nixos/modules/services/misc/gitlab.nix index d5dfc22dc226..c5eed5960e54 100644 --- a/nixos/modules/services/misc/gitlab.nix +++ b/nixos/modules/services/misc/gitlab.nix @@ -1503,7 +1503,7 @@ in { }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc gitlab.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > gitlab.xml` + # `pandoc gitlab.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > gitlab.xml` meta.doc = ./gitlab.xml; } diff --git a/nixos/modules/services/misc/gitlab.xml b/nixos/modules/services/misc/gitlab.xml index 42e26afa824b..c2c4dc895e9c 100644 --- a/nixos/modules/services/misc/gitlab.xml +++ b/nixos/modules/services/misc/gitlab.xml @@ -78,13 +78,13 @@ services.gitlab = { }; - If you're setting up a new GitLab instance, generate new secrets. + If you’re setting up a new GitLab instance, generate new secrets. You for instance use tr -dc A-Za-z0-9 < /dev/urandom | head -c 128 > /var/keys/gitlab/db to generate a new db secret. Make sure the files can be read by, and only by, the user specified by services.gitlab.user. - GitLab encrypts sensitive data stored in the database. If you're + GitLab encrypts sensitive data stored in the database. If you’re restoring an existing GitLab instance, you must specify the secrets secret from config/secrets.yml located in your GitLab state folder. @@ -125,7 +125,7 @@ $ systemctl start gitlab-backup.service
Rake tasks - You can run GitLab's rake tasks with + You can run GitLab’s rake tasks with gitlab-rake which will be available on the system when GitLab is enabled. You will have to run the command as the user that you configured to run GitLab with. diff --git a/nixos/modules/services/misc/sourcehut/default.nix b/nixos/modules/services/misc/sourcehut/default.nix index da3bf0698130..c95761bbe97e 100644 --- a/nixos/modules/services/misc/sourcehut/default.nix +++ b/nixos/modules/services/misc/sourcehut/default.nix @@ -1391,7 +1391,7 @@ in ]; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc sourcehut.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > sourcehut.xml` + # `pandoc sourcehut.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > sourcehut.xml` meta.doc = ./sourcehut.xml; meta.maintainers = with maintainers; [ tomberek ]; } diff --git a/nixos/modules/services/misc/sourcehut/sourcehut.xml b/nixos/modules/services/misc/sourcehut/sourcehut.xml index 883b6f01ef81..d54a9c744173 100644 --- a/nixos/modules/services/misc/sourcehut/sourcehut.xml +++ b/nixos/modules/services/misc/sourcehut/sourcehut.xml @@ -97,12 +97,12 @@ in {
- Using an alternative webserver as reverse-proxy (e.g. - <literal>httpd</literal>) + Using an alternative webserver as reverse-proxy + (e.g. <literal>httpd</literal>) By default, nginx is used as reverse-proxy for - sourcehut. However, it's possible to use e.g. - httpd by explicitly disabling + sourcehut. However, it’s possible to use + e.g. httpd by explicitly disabling nginx using and fixing the settings. diff --git a/nixos/modules/services/misc/taskserver/default.nix b/nixos/modules/services/misc/taskserver/default.nix index c39cde810617..9a97d236452e 100644 --- a/nixos/modules/services/misc/taskserver/default.nix +++ b/nixos/modules/services/misc/taskserver/default.nix @@ -567,6 +567,6 @@ in { ]; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > doc.xml` + # `pandoc doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > doc.xml` meta.doc = ./doc.xml; } diff --git a/nixos/modules/services/misc/taskserver/doc.xml b/nixos/modules/services/misc/taskserver/doc.xml index fb7c7be99feb..06ec397661a0 100644 --- a/nixos/modules/services/misc/taskserver/doc.xml +++ b/nixos/modules/services/misc/taskserver/doc.xml @@ -16,7 +16,7 @@ certificates, so you either need to roll your own CA or purchase a certificate from a known CA, which allows creation of client certificates. These certificates are usually advertised as - "server certificates". + server certificates. So in order to make it easier to handle your own CA, there is a @@ -54,7 +54,7 @@ For example if you add a new organisation using nixos-taskserver org add foo, the organisation is not modified and deleted no matter what you define in - , even if you're + , even if you’re adding the same organisation in that option. @@ -80,7 +80,7 @@ client machine. - For example, let's say you have the following configuration: + For example, let’s say you have the following configuration: { @@ -121,7 +121,7 @@ $ ssh server nixos-taskserver user export my-company alice | sh If you set any options within service.taskserver.pki.manual.*, - nixos-taskserver won't issue certificates, but + nixos-taskserver won’t issue certificates, but you can still use it for adding or removing user accounts.
diff --git a/nixos/modules/services/monitoring/prometheus/exporters.nix b/nixos/modules/services/monitoring/prometheus/exporters.nix index e14eb51e7047..e9401334352c 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters.nix @@ -324,7 +324,7 @@ in meta = { # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc exporters.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > exporters.xml` + # `pandoc exporters.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > exporters.xml` doc = ./exporters.xml; maintainers = [ maintainers.willibutz ]; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters.xml b/nixos/modules/services/monitoring/prometheus/exporters.xml index 066903a81b3c..f813f3cc39a0 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters.xml +++ b/nixos/modules/services/monitoring/prometheus/exporters.xml @@ -11,7 +11,7 @@ One of the most common exporters is the node exporter, it provides hardware and OS metrics from the host - it's running on. The exporter could be configured as follows: + it’s running on. The exporter could be configured as follows: services.prometheus.exporters.node = { @@ -34,7 +34,7 @@ enabled by default, via http under /metrics. In this example the firewall should just allow incoming connections - to the exporter's port on the bridge interface + to the exporter’s port on the bridge interface br0 (this would have to be configured separately of course). For more information about configuration see man configuration.nix or search through the @@ -194,9 +194,9 @@ in This should already be enough for the postfix exporter. Additionally one could now add assertions and conditional - default values. This can be done in the 'meta-module' that - combines all exporter definitions and generates the - submodules: + default values. This can be done in the + meta-module that combines all exporter + definitions and generates the submodules: nixpkgs/nixos/modules/services/prometheus/exporters.nix diff --git a/nixos/modules/services/network-filesystems/litestream/default.nix b/nixos/modules/services/network-filesystems/litestream/default.nix index 24ac3130f36c..73ef81a0f56e 100644 --- a/nixos/modules/services/network-filesystems/litestream/default.nix +++ b/nixos/modules/services/network-filesystems/litestream/default.nix @@ -96,6 +96,6 @@ in }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc litestream.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > litestream.xml` + # `pandoc litestream.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > litestream.xml` meta.doc = ./litestream.xml; } diff --git a/nixos/modules/services/network-filesystems/litestream/litestream.xml b/nixos/modules/services/network-filesystems/litestream/litestream.xml index 6ea40c8bf474..0a2cfc3db1e9 100644 --- a/nixos/modules/services/network-filesystems/litestream/litestream.xml +++ b/nixos/modules/services/network-filesystems/litestream/litestream.xml @@ -9,7 +9,7 @@ Litestream service is managed by a dedicated user named litestream which needs permission to the - database file. Here's an example config which gives required + database file. Here’s an example config which gives required permissions to access grafana database: diff --git a/nixos/modules/services/networking/pleroma.nix b/nixos/modules/services/networking/pleroma.nix index d4d659a41d18..287e189e2fe0 100644 --- a/nixos/modules/services/networking/pleroma.nix +++ b/nixos/modules/services/networking/pleroma.nix @@ -148,6 +148,6 @@ in { }; meta.maintainers = with lib.maintainers; [ ninjatrappeur ]; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc pleroma.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > pleroma.xml` + # `pandoc pleroma.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > pleroma.xml` meta.doc = ./pleroma.xml; } diff --git a/nixos/modules/services/networking/pleroma.xml b/nixos/modules/services/networking/pleroma.xml index 5014ac644f74..9a29512d363a 100644 --- a/nixos/modules/services/networking/pleroma.xml +++ b/nixos/modules/services/networking/pleroma.xml @@ -136,7 +136,7 @@ config :web_push_encryption, :vapid_details, Note that the lines of the same configuration group are comma - separated (i.e. all the lines end with a comma, except the last + separated (i.e. all the lines end with a comma, except the last one), so when the lines with passwords are added or removed, commas must be adjusted accordingly. @@ -179,7 +179,7 @@ $ pleroma_ctl user new <nickname> <email> --admin --moderator --pas 4000. Nginx can be configured as a Reverse Proxy, for forwarding requests from public ports to the Pleroma service. This is an example of configuration, using - Let's Encrypt + Let’s Encrypt for the TLS certificates diff --git a/nixos/modules/services/networking/prosody.nix b/nixos/modules/services/networking/prosody.nix index 07d3afa73b1c..3c685e30b032 100644 --- a/nixos/modules/services/networking/prosody.nix +++ b/nixos/modules/services/networking/prosody.nix @@ -906,6 +906,6 @@ in }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc prosody.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > prosody.xml` + # `pandoc prosody.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > prosody.xml` meta.doc = ./prosody.xml; } diff --git a/nixos/modules/services/networking/prosody.xml b/nixos/modules/services/networking/prosody.xml index 32b5dc8c129f..2323f7596dfc 100644 --- a/nixos/modules/services/networking/prosody.xml +++ b/nixos/modules/services/networking/prosody.xml @@ -24,7 +24,7 @@ Multi User Chat (MUC) and the HTTP - File Upload ones. You'll need to create a DNS subdomain for + File Upload ones. You’ll need to create a DNS subdomain for each of those. The current convention is to name your MUC endpoint conference.example.org and your HTTP upload domain upload.example.org. @@ -58,18 +58,18 @@ services.prosody = {
- Let's Encrypt Configuration + Let’s Encrypt Configuration As you can see in the code snippet from the previous - section, you'll need a single TLS certificate covering your + section, you’ll need a single TLS certificate covering your main endpoint, the MUC one as well as the HTTP Upload one. We can generate such a certificate by leveraging the ACME extraDomainNames module option. - Provided the setup detailed in the previous section, you'll need + Provided the setup detailed in the previous section, you’ll need the following acme configuration to generate a TLS certificate for the three endponits: diff --git a/nixos/modules/services/networking/yggdrasil.nix b/nixos/modules/services/networking/yggdrasil.nix index 88ab728fc51c..3c3ff4ce3c48 100644 --- a/nixos/modules/services/networking/yggdrasil.nix +++ b/nixos/modules/services/networking/yggdrasil.nix @@ -194,7 +194,7 @@ in { }); meta = { # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc yggdrasil.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > yggdrasil.xml` + # `pandoc yggdrasil.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > yggdrasil.xml` doc = ./yggdrasil.xml; maintainers = with lib.maintainers; [ gazally ehmry ]; }; diff --git a/nixos/modules/services/web-apps/discourse.nix b/nixos/modules/services/web-apps/discourse.nix index 834e0f123409..2796ba8c379e 100644 --- a/nixos/modules/services/web-apps/discourse.nix +++ b/nixos/modules/services/web-apps/discourse.nix @@ -1081,7 +1081,7 @@ in }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc discourse.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > discourse.xml` + # `pandoc discourse.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > discourse.xml` meta.doc = ./discourse.xml; meta.maintainers = [ lib.maintainers.talyz ]; } diff --git a/nixos/modules/services/web-apps/discourse.xml b/nixos/modules/services/web-apps/discourse.xml index c33cf7eaf735..1aec160b7b40 100644 --- a/nixos/modules/services/web-apps/discourse.xml +++ b/nixos/modules/services/web-apps/discourse.xml @@ -7,7 +7,7 @@
Basic usage - A minimal configuration using Let's Encrypt for TLS certificates + A minimal configuration using Let’s Encrypt for TLS certificates looks like this: @@ -26,7 +26,7 @@ security.acme.email = "me@example.com"; security.acme.acceptTerms = true; - Provided a proper DNS setup, you'll be able to connect to the + Provided a proper DNS setup, you’ll be able to connect to the instance at discourse.example.com and log in using the credentials provided in services.discourse.admin. @@ -82,7 +82,7 @@ services.discourse = {
Email - In addition to the basic setup, you'll want to configure an SMTP + In addition to the basic setup, you’ll want to configure an SMTP server Discourse can use to send user registration and password reset emails, among others. You can also optionally let Discourse receive email, which enables people to reply to threads and @@ -116,11 +116,11 @@ services.discourse = { }; - This assumes you have set up an MX record for the address you've + This assumes you have set up an MX record for the address you’ve set in hostname and requires proper SPF, DKIM and DMARC configuration to be done - for the domain you're sending from, in order for email to be + for the domain you’re sending from, in order for email to be reliably delivered. @@ -135,7 +135,7 @@ services.discourse = { Setup of TLS for incoming email is currently only configured - automatically when a regular TLS certificate is used, i.e. when + automatically when a regular TLS certificate is used, i.e. when and @@ -155,18 +155,18 @@ services.discourse = {
Site settings - "Site settings" are the settings that can be changed - through the Discourse UI. Their default - values can be set using + Site settings are the settings that can be + changed through the Discourse UI. Their + default values can be set using . Settings are expressed as a Nix attribute set which matches the structure of the configuration in config/site_settings.yml. - To find a setting's path, you only need to care about the first - two levels; i.e. its category (e.g. login) - and name (e.g. invite_only). + To find a setting’s path, you only need to care about the first + two levels; i.e. its category (e.g. login) + and name (e.g. invite_only). Settings containing secret data should be set to an attribute @@ -263,7 +263,7 @@ services.discourse = { Developing with Ruby section of the Nixpkgs manual and the appropriate gem options set in bundlerEnvArgs (normally - gemdir is sufficient). A plugin's Ruby + gemdir is sufficient). A plugin’s Ruby dependencies are listed in its plugin.rb file as function calls to gem. To construct the corresponding Gemfile manually, run diff --git a/nixos/modules/services/web-apps/grocy.nix b/nixos/modules/services/web-apps/grocy.nix index 1716f27ccad7..187eed8f0c8d 100644 --- a/nixos/modules/services/web-apps/grocy.nix +++ b/nixos/modules/services/web-apps/grocy.nix @@ -168,7 +168,7 @@ in { meta = { maintainers = with maintainers; [ ma27 ]; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc grocy.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > grocy.xml` + # `pandoc grocy.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > grocy.xml` doc = ./grocy.xml; }; } diff --git a/nixos/modules/services/web-apps/grocy.xml b/nixos/modules/services/web-apps/grocy.xml index b02627aaafeb..5a0e043ea4d9 100644 --- a/nixos/modules/services/web-apps/grocy.xml +++ b/nixos/modules/services/web-apps/grocy.xml @@ -29,7 +29,7 @@ credentials admin:admin can be used to login. - The application's state is persisted at + The application’s state is persisted at /var/lib/grocy/grocy.db in a sqlite3 database. The migration is applied when requesting the /-route of the application. diff --git a/nixos/modules/services/web-apps/jitsi-meet.nix b/nixos/modules/services/web-apps/jitsi-meet.nix index 19ac9427f4ab..2c2d5f21319a 100644 --- a/nixos/modules/services/web-apps/jitsi-meet.nix +++ b/nixos/modules/services/web-apps/jitsi-meet.nix @@ -452,7 +452,7 @@ in }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc jitsi-meet.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > jitsi-meet.xml` + # `pandoc jitsi-meet.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > jitsi-meet.xml` meta.doc = ./jitsi-meet.xml; meta.maintainers = lib.teams.jitsi.members; } diff --git a/nixos/modules/services/web-apps/jitsi-meet.xml b/nixos/modules/services/web-apps/jitsi-meet.xml index 18c4e5b52cc2..f5cfadf89dfc 100644 --- a/nixos/modules/services/web-apps/jitsi-meet.xml +++ b/nixos/modules/services/web-apps/jitsi-meet.xml @@ -7,7 +7,7 @@
Basic usage - A minimal configuration using Let's Encrypt for TLS certificates + A minimal configuration using Let’s Encrypt for TLS certificates looks like this: diff --git a/nixos/modules/services/web-apps/keycloak.nix b/nixos/modules/services/web-apps/keycloak.nix index a1f13f159f94..8d7f046aa117 100644 --- a/nixos/modules/services/web-apps/keycloak.nix +++ b/nixos/modules/services/web-apps/keycloak.nix @@ -675,7 +675,7 @@ in }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc keycloak.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > keycloak.xml` + # `pandoc keycloak.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > keycloak.xml` meta.doc = ./keycloak.xml; meta.maintainers = [ maintainers.talyz ]; } diff --git a/nixos/modules/services/web-apps/keycloak.xml b/nixos/modules/services/web-apps/keycloak.xml index f6602a3c70df..a15cd9a4188f 100644 --- a/nixos/modules/services/web-apps/keycloak.xml +++ b/nixos/modules/services/web-apps/keycloak.xml @@ -76,8 +76,8 @@ - If you're migrating an old Wildfly based Keycloak instance and - want to keep compatibility with your current clients, you'll + If you’re migrating an old Wildfly based Keycloak instance and + want to keep compatibility with your current clients, you’ll likely want to set to /auth. See the option description for more @@ -102,7 +102,7 @@
Setting up TLS/SSL - By default, Keycloak won't accept unsecured HTTP connections + By default, Keycloak won’t accept unsecured HTTP connections originating from outside its local network. diff --git a/nixos/modules/services/web-apps/matomo-doc.xml b/nixos/modules/services/web-apps/matomo-doc.xml index af445a9e627e..0254d978698c 100644 --- a/nixos/modules/services/web-apps/matomo-doc.xml +++ b/nixos/modules/services/web-apps/matomo-doc.xml @@ -41,8 +41,8 @@ GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost'; https://mariadb.com/kb/en/mariadb/unix_socket-authentication-plugin/. - Of course, you can use password based authentication as well, e.g. - when the database is not on the same host. + Of course, you can use password based authentication as well, + e.g. when the database is not on the same host.
@@ -84,7 +84,7 @@ GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost'; Matomo will warn you that the JavaScript tracker is not - writable. This is because it's located in the read-only nix + writable. This is because it’s located in the read-only nix store. You can safely ignore this, unless you need a plugin that needs JavaScript tracker access. diff --git a/nixos/modules/services/web-apps/matomo.nix b/nixos/modules/services/web-apps/matomo.nix index fcc5dc5650e3..eb204eb3f3d8 100644 --- a/nixos/modules/services/web-apps/matomo.nix +++ b/nixos/modules/services/web-apps/matomo.nix @@ -326,7 +326,7 @@ in { meta = { # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc matomo-doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > matomo-doc.xml` + # `pandoc matomo-doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > matomo-doc.xml` doc = ./matomo-doc.xml; maintainers = with lib.maintainers; [ florianjacob ]; }; diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix index 580064865644..3d30c712f674 100644 --- a/nixos/modules/services/web-apps/nextcloud.nix +++ b/nixos/modules/services/web-apps/nextcloud.nix @@ -1147,6 +1147,6 @@ in { ]); # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc nextcloud.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > nextcloud.xml` + # `pandoc nextcloud.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > nextcloud.xml` meta.doc = ./nextcloud.xml; } diff --git a/nixos/modules/services/web-apps/nextcloud.xml b/nixos/modules/services/web-apps/nextcloud.xml index 7d4b074514c2..0998f29bac27 100644 --- a/nixos/modules/services/web-apps/nextcloud.xml +++ b/nixos/modules/services/web-apps/nextcloud.xml @@ -19,7 +19,7 @@ (services.nextcloud optionally supports services.nginx) - and a database (it's recommended to use + and a database (it’s recommended to use services.postgresql). @@ -67,13 +67,13 @@ and nginx. The config attribute set is used by the imperative installer and all values are written to an additional file to ensure that changes can be - applied by changing the module's options. + applied by changing the module’s options. In case the application serves multiple domains (those are checked with $_SERVER['HTTP_HOST']) - it's needed to add them to + it’s needed to add them to services.nextcloud.config.extraTrustedDomains. @@ -101,19 +101,19 @@ which is generated by the module and linked from the store to ensure that all values from config.php can be modified by the module. However - config.php manages the application's - state and shouldn't be touched manually because of that. + config.php manages the application’s + state and shouldn’t be touched manually because of that. - Don't delete config.php! This file - tracks the application's state and a deletion can cause + Don’t delete config.php! This file + tracks the application’s state and a deletion can cause unwanted side-effects! - Don't rerun + Don’t rerun nextcloud-occ maintenance:install! This command tries to install the application and can cause unwanted side-effects! @@ -123,8 +123,8 @@ Multiple version upgrades. - Nextcloud doesn't allow to move more than one major-version - forward. E.g., if you're on v16, you cannot + Nextcloud doesn’t allow to move more than one major-version + forward. E.g., if you’re on v16, you cannot upgrade to v18, you need to upgrade to v17 first. This is ensured automatically as long as the @@ -159,7 +159,7 @@ this is most likely because the maintenance mode is active. It can be deactivated by running nextcloud-occ maintenance:mode --off. - It's advisable though to check the logs first on why the + It’s advisable though to check the logs first on why the maintenance mode was activated. @@ -175,8 +175,8 @@ deleting /var/lib/nextcloud/config/config.php. This is the only time advisable because the fresh install - doesn't have any state that can be lost. In case that - doesn't help, an entire re-creation can be forced via + doesn’t have any state that can be lost. In case that + doesn’t help, an entire re-creation can be forced via rm -rf ~nextcloud/. @@ -189,8 +189,8 @@ server-side encryption (SSE). This is not an end-to-end encryption, but can be used to encrypt files that will be persisted to - external storage such as S3. Please note that this won't work - anymore when using OpenSSL 3 for PHP's openssl extension + external storage such as S3. Please note that this won’t work + anymore when using OpenSSL 3 for PHP’s openssl extension because this is implemented using the legacy cipher RC4. If is above 22.05, this is @@ -202,12 +202,12 @@
- Using an alternative webserver as reverse-proxy (e.g. - <literal>httpd</literal>) + Using an alternative webserver as reverse-proxy + (e.g. <literal>httpd</literal>) By default, nginx is used as reverse-proxy for - nextcloud. However, it's possible to use e.g. - httpd by explicitly disabling + nextcloud. However, it’s possible to use + e.g. httpd by explicitly disabling nginx using and fixing the settings listen.owner & @@ -292,12 +292,12 @@ While minor and patch-level updates are no problem and can be done directly in the package-expression (and should be backported to supported stable branches after that), major-releases should be - added in a new attribute (e.g. Nextcloud + added in a new attribute (e.g. Nextcloud v19.0.0 should be available in nixpkgs as pkgs.nextcloud19). To provide simple upgrade - paths it's generally useful to backport those as well to stable - branches. As long as the package-default isn't altered, this won't + paths it’s generally useful to backport those as well to stable + branches. As long as the package-default isn’t altered, this won’t break existing setups. After that, the versioning-warning in the nextcloud-module should be updated to make sure that the @@ -322,9 +322,9 @@ } - Ideally we should make sure that it's possible to jump two NixOS - versions forward: i.e. the warnings and the logic in the module - should guard a user to upgrade from a Nextcloud on e.g. 19.09 to a + Ideally we should make sure that it’s possible to jump two NixOS + versions forward: i.e. the warnings and the logic in the module + should guard a user to upgrade from a Nextcloud on e.g. 19.09 to a Nextcloud on 20.09.
diff --git a/nixos/modules/services/web-apps/plausible.nix b/nixos/modules/services/web-apps/plausible.nix index bbad8152b532..cb46a88cd9f5 100644 --- a/nixos/modules/services/web-apps/plausible.nix +++ b/nixos/modules/services/web-apps/plausible.nix @@ -293,6 +293,6 @@ in { meta.maintainers = with maintainers; [ ma27 ]; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc plausible.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > plausible.xml` + # `pandoc plausible.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > plausible.xml` meta.doc = ./plausible.xml; } diff --git a/nixos/modules/services/web-servers/garage-doc.xml b/nixos/modules/services/web-servers/garage-doc.xml index 36e73e676d3c..447a27d2bf85 100644 --- a/nixos/modules/services/web-servers/garage-doc.xml +++ b/nixos/modules/services/web-servers/garage-doc.xml @@ -36,7 +36,7 @@ Until 1.0 is released, patch-level upgrades are considered as minor version upgrades. Minor version upgrades are considered as - major version upgrades. i.e. 0.6 to 0.7 is a major version + major version upgrades. i.e. 0.6 to 0.7 is a major version upgrade. @@ -45,7 +45,7 @@ Straightforward upgrades (patch-level upgrades). Upgrades must be performed one by one, - i.e. for each node, stop it, upgrade it : change + i.e. for each node, stop it, upgrade it : change stateVersion or services.garage.package, restart it if it was not already by switching. @@ -55,7 +55,7 @@ Multiple version upgrades. Garage do not provide any guarantee on moving more than one - major-version forward. E.g., if you're on + major-version forward. E.g., if you’re on 0.7, you cannot upgrade to 0.9. You need to upgrade to 0.8 first. As long as @@ -110,7 +110,7 @@ - Backup the metadata folder of ALL your nodes, e.g. for a + Backup the metadata folder of ALL your nodes, e.g. for a metadata directory (the default one) in /var/lib/garage/meta, you can run pushd /var/lib/garage; tar -acf meta-v0.7.tar.zst meta/; popd. @@ -166,11 +166,11 @@ While patch-level updates are no problem and can be done directly in the package-expression (and should be backported to supported stable branches after that), major-releases should be added in a - new attribute (e.g. Garage v0.8.0 should be + new attribute (e.g. Garage v0.8.0 should be available in nixpkgs as pkgs.garage_0_8_0). To provide simple upgrade - paths it's generally useful to backport those as well to stable - branches. As long as the package-default isn't altered, this won't + paths it’s generally useful to backport those as well to stable + branches. As long as the package-default isn’t altered, this won’t break existing setups. After that, the versioning-warning in the garage-module should be updated to make sure that the @@ -195,9 +195,9 @@ } - Ideally we should make sure that it's possible to jump two NixOS - versions forward: i.e. the warnings and the logic in the module - should guard a user to upgrade from a Garage on e.g. 22.11 to a + Ideally we should make sure that it’s possible to jump two NixOS + versions forward: i.e. the warnings and the logic in the module + should guard a user to upgrade from a Garage on e.g. 22.11 to a Garage on 23.11.
diff --git a/nixos/modules/services/web-servers/garage.nix b/nixos/modules/services/web-servers/garage.nix index eac0edc9d6fa..ed5b89f916c6 100644 --- a/nixos/modules/services/web-servers/garage.nix +++ b/nixos/modules/services/web-servers/garage.nix @@ -10,7 +10,7 @@ in { meta = { # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc garage-doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > garage-doc.xml` + # `pandoc garage-doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > garage-doc.xml` doc = ./garage-doc.xml; maintainers = with pkgs.lib.maintainers; [ raitobezarius ]; }; diff --git a/nixos/modules/services/x11/desktop-managers/gnome.nix b/nixos/modules/services/x11/desktop-managers/gnome.nix index 21c3608290cf..62535e996bb6 100644 --- a/nixos/modules/services/x11/desktop-managers/gnome.nix +++ b/nixos/modules/services/x11/desktop-managers/gnome.nix @@ -67,7 +67,7 @@ in meta = { # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc gnome.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > gnome.xml` + # `pandoc gnome.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > gnome.xml` doc = ./gnome.xml; maintainers = teams.gnome.members; }; diff --git a/nixos/modules/services/x11/desktop-managers/pantheon.nix b/nixos/modules/services/x11/desktop-managers/pantheon.nix index 25d5d8612944..14a03c0408ee 100644 --- a/nixos/modules/services/x11/desktop-managers/pantheon.nix +++ b/nixos/modules/services/x11/desktop-managers/pantheon.nix @@ -18,7 +18,7 @@ in meta = { # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc pantheon.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > pantheon.xml` + # `pandoc pantheon.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > pantheon.xml` doc = ./pantheon.xml; maintainers = teams.pantheon.members; }; diff --git a/nixos/modules/services/x11/desktop-managers/pantheon.xml b/nixos/modules/services/x11/desktop-managers/pantheon.xml index 27ed5977ff02..5aa575aeec4a 100644 --- a/nixos/modules/services/x11/desktop-managers/pantheon.xml +++ b/nixos/modules/services/x11/desktop-managers/pantheon.xml @@ -17,8 +17,8 @@ services.xserver.desktopManager.pantheon.enable = true; - This automatically enables LightDM and Pantheon's LightDM greeter. - If you'd like to disable this, set + This automatically enables LightDM and Pantheon’s LightDM greeter. + If you’d like to disable this, set services.xserver.displayManager.lightdm.greeters.pantheon.enable = false; @@ -27,8 +27,8 @@ services.xserver.displayManager.lightdm.enable = false; but please be aware using Pantheon without LightDM as a display manager will break screenlocking from the UI. The NixOS module for - Pantheon installs all of Pantheon's default applications. If you'd - like to not install Pantheon's apps, set + Pantheon installs all of Pantheon’s default applications. If you’d + like to not install Pantheon’s apps, set services.pantheon.apps.enable = false; @@ -86,7 +86,7 @@ switchboard-with-plugs.override { please note that, like how the NixOS options describe these as extra plugins, this would only add to the default plugins included - with the programs. If for some reason you'd like to configure + with the programs. If for some reason you’d like to configure which plugins to use exactly, both packages have an argument for this: