foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-01-30 22:57:55 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs/site: update cross-references

Browse Source 
I forgot to update them along with the restructure. :)
This commit is contained in:
Gabriel Arazas 2023-07-14 19:09:23 +08:00
parent 0830f1a5c9
commit 4ef59b81ca
No known key found for this signature in database
GPG Key ID: ADE0C41DAB221FCC
6 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/content/en-US/02-lay-of-the-land/01-prerequisites/index.adoc
View File

@ -32,6 +32,6 @@ nixos-install --flake {canonical-flake-url}#INSTALLABLE
Despite being a NixOS system, it isn't entirely reproducible to the point of installing this config will work out-of-the-box.
It has some things needed in the first place to work like my external backup setup where it needs my SSH private keys to work in the first place.
You can see more details from xref:../what-should-not-be-here/index.adoc[What should not be here?].
You can see more details from xref:../05-what-should-not-be-here/index.adoc[What should not be here?].
Nonetheless, the parts is it isn't reproducible is only about 10% of this config.
Everything else is fine and dandy and can be deployed successfully (but not used as intended).

8
docs/content/en-US/02-lay-of-the-land/02-project-structure/index.adoc
View File

@ -31,12 +31,12 @@ nixos-config
----
One of the more notable files here when first start looking is the `./images.toml` file where it contains a description of the images.
For more details, see xref:../../project-specific-setup/declarative-host-management/index.adoc[Declarative host management].
For more details, see xref:../../03-project-specific-setup/01-declarative-host-management/index.adoc[Declarative host management].
A similar file, `./users.toml`, contains the description for the home-manager users to be exported from this flake.
For more details, see xref:../../project-specific-setup/declarative-user-management/index.adoc[Declarative user management].
For more details, see xref:../../03-project-specific-setup/02-declarative-user-management/index.adoc[Declarative user management].
Most of the said folders are related to a flake output attribute, see xref:../whats-in-my-flake/index.adoc[What's in my flake?] for more details.
Most of the said folders are related to a flake output attribute, see xref:../03-whats-in-my-flake/index.adoc[What's in my flake?] for more details.
* `./hosts/` contain machine-specific configuration.
This usually configures like the hardware setup, timezone, and users.
@ -53,7 +53,7 @@ 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:../../project-specific-setup/secrets-management/index.adoc[Secrets management].
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).

2
docs/content/en-US/02-lay-of-the-land/05-what-should-not-be-here/index.adoc
View File

@ -7,7 +7,7 @@ Despite being a NixOS configuration, this is not meant to be fully reproducible
There are still some things that would need to be privately held as indicated by the following list.
- Associated private keys: GPG, SSH, age, you name it.
They are used with a secret management tool (see xref:../../project-specific-setup/secrets-management/index.adoc[Secret management] for more information) to encrypt the more sensitive parts of the system such as credentials and environment files.
They are used with a secret management tool (see xref:../../03-project-specific-setup/03-secrets-management/index.adoc[Secret management] for more information) to encrypt the more sensitive parts of the system such as credentials and environment files.
- Disposable hosts configurations.
They will typically just make a messier mess than the current situation.

2
docs/content/en-US/03-project-specific-setup/02-declarative-user-management/index.adoc
View File

@ -3,7 +3,7 @@ title: Declarative user management
---
= Declarative user management
Similarly to xref:../declarative-host-management/index.adoc[Declarative host management], this project also provides a way to declare home-manager users.
Similarly to xref:../02-declarative-user-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.

2
docs/content/en-US/04-nixos-modules/03-disko/index.adoc
View File

@ -4,7 +4,7 @@ title: disko
= disko
This configuration uses github:nix-community/disko[opts=repo] extensively for creating them filesystem configurations and automating them filesystem partitioning.
Take note this should be only declared for hosts with the format `iso` (or without the format) as mentioned from xref:../../project-specific-setup/declarative-host-management/index.adoc[Declarative host management].
Take note this should be only declared for hosts with the format `iso` (or without the format) as mentioned from xref:../../03-project-specific-setup/01-declarative-host-management/index.adoc[Declarative host management].
They are declared in the `disko.nix` at the host root which they are then imported into `disko.devices` attribute.
Here's an example configuration for my desktop workstation.

4
docs/content/en-US/05-using-parts-of-my-configuration/index.adoc
View File

@ -23,7 +23,7 @@ To start, you can simply add my flake to your list of flake inputs.
inputs.foo-dogsquared-nixos-config.url = "{canonical-flake-url}";
----
Then, you could use parts of the config as exported from my flake which you can refer back to xref:../lay-of-the-land/whats-in-my-flake/index.adoc[What's in my flake?].
Then, you could use parts of the config as exported from my flake which you can refer back to xref:../02-lay-of-the-land/03-whats-in-my-flake/index.adoc[What's in my flake?].
For example, you could make use of my packages by adding them as an overlay which is recommended if you're going to use my NixOS modules anyways.
Here's one way to put as part of your NixOS configuration...
@ -90,7 +90,7 @@ nix-channel --update
import <foo-dogsquared-nixos-config> { inherit pkgs; }
----
You can see github:{github-repo}[`./default.nix`, path=default.nix, rev=master] to see more details but there are general guidelines to the attributes that is contained in this file which is outlined in xref:../lay-of-the-land/channels-support/index.adoc[Channels support] section.
You can see github:{github-repo}[`./default.nix`, path=default.nix, rev=master] to see more details but there are general guidelines to the attributes that is contained in this file which is outlined in xref:../02-lay-of-the-land/04-channels-support/index.adoc[Channels support] section.
Here's an example snippet in a NixOS config making use of my configuration without flakes: