From 79b6ada1aa0413a8b2b8c76d17030cee863cf880 Mon Sep 17 00:00:00 2001 From: Gabriel Arazas Date: Mon, 18 Dec 2023 18:03:18 +0800 Subject: [PATCH] docs/site: update descriptions --- .../02-lay-of-the-land/02-project-structure/index.adoc | 9 --------- .../01-declarative-host-management/index.adoc | 7 +------ .../02-declarative-user-management/index.adoc | 2 +- 3 files changed, 2 insertions(+), 16 deletions(-) diff --git a/docs/content/en-US/02-lay-of-the-land/02-project-structure/index.adoc b/docs/content/en-US/02-lay-of-the-land/02-project-structure/index.adoc index f6641cdc..3111fe15 100644 --- a/docs/content/en-US/02-lay-of-the-land/02-project-structure/index.adoc +++ b/docs/content/en-US/02-lay-of-the-land/02-project-structure/index.adoc @@ -18,8 +18,6 @@ nixos-config ├── modules/ ├── overlays/ ├── pkgs/ -├── scripts/ -├── secrets/ ├── shells/ ├── templates/ ├── users/ @@ -55,13 +53,6 @@ This is typically used exclusively for the project and advised to not use it if * `./pkgs/` contains my custom packages. It is exported in the flakes at `outputs.packages` compiled through various systems. -* `./scripts/` contains various scripts for various purposes. -Should be self-explanatory. - -* `./secrets/` contains my cluster-wide secrets managed with github:mozilla/sops[opts=repo] and github:Mic92/sops-nix[opts=repo]. -Take note, each component (e.g., hosts, modules, users) could have their own specific secrets. -For more information, see xref:../../03-project-specific-setup/03-secrets-management/index.adoc[Secrets management]. - * `./shells/` contains my development shells for interacting with the usual type of projects. Setting this up can bring benefits outside of NixOS (unless you're interacting with projects with any OpenGL-related stuff). footnote:[Since packages brought from Nix shells can only work with the store, a container might be better at some situations.] diff --git a/docs/content/en-US/03-project-specific-setup/01-declarative-host-management/index.adoc b/docs/content/en-US/03-project-specific-setup/01-declarative-host-management/index.adoc index 22a0781a..1562bfd7 100644 --- a/docs/content/en-US/03-project-specific-setup/01-declarative-host-management/index.adoc +++ b/docs/content/en-US/03-project-specific-setup/01-declarative-host-management/index.adoc @@ -67,12 +67,7 @@ By default, it uses `home-manager` flake input which follows the `home-manager-u - `deploy` is a table containing arguments from github:serokell/deploy-rs[opts=repo]. Only a few arguments are accepted (i.e., `hostname`, `fast-connection`, `remote-build`, `magic-rollback`, and `auto-rollback`). -Take note only certain hosts can be considered as a NixOS configuration (e.g., `nixosConfigurations`). -Specifically, those images with a format of `iso` and those without (since they fall back to `iso` anyways). -Otherwise, most images are intended to be built. -footnote:[Though, one could create a custom activation and deployment script with deploy-rs.] - -Furthermore, those imported NixOS configurations are also exported as part of the deploy nodes for deploy-rs with the `nixos` prefix. +Those imported NixOS configurations are also exported as part of the deploy nodes for deploy-rs with the `nixos` prefix. For example, here's the command to deploy my Plover server. [source, shell, subs=attributes] diff --git a/docs/content/en-US/03-project-specific-setup/02-declarative-user-management/index.adoc b/docs/content/en-US/03-project-specific-setup/02-declarative-user-management/index.adoc index 529f56ab..0342536f 100644 --- a/docs/content/en-US/03-project-specific-setup/02-declarative-user-management/index.adoc +++ b/docs/content/en-US/03-project-specific-setup/02-declarative-user-management/index.adoc @@ -3,7 +3,7 @@ title: Declarative user management --- = Declarative user management -Similarly to xref:../02-declarative-host-management/index.adoc[Declarative host management], this project also provides a way to declare home-manager users. +Similarly to xref:../01-declarative-host-management/index.adoc[Declarative host management], this project also provides a way to declare home-manager users. The `users.toml` sits in the project root expecting certain data. Similar to `images.toml`, it expects a table of users with each representing one of the users from github:{github-repo}[`./users/home-manager/`, path=./users/home-manager/, rev=master]. These are then included as part of `homeConfigurations` for easier installation with the standalone home-manager tool.