docs/infrastructure: embed host config json

dev/docs.nix

@@ -1,39 +1,64 @@
-{ config, pkgs, ... }:
+{ self, ... }:
 {
-  devShells.mkdocs = pkgs.mkShellNoCC { inputsFrom = [ config.packages.docs ]; };
-  packages = {
-    docs =
-      pkgs.runCommand "docs"
-        {
-          buildInputs = [
-            pkgs.python3.pkgs.mkdocs-material
-            pkgs.python3.pkgs.mkdocs-material.optional-dependencies.recommended
-          ];
-          files = pkgs.lib.fileset.toSource {
-            root = ../.;
-            fileset = pkgs.lib.fileset.unions [
-              ../docs
-              ../mkdocs.yml
-            ];
+  perSystem =
+    { config, pkgs, ... }:
+    {
+      devShells.mkdocs = pkgs.mkShellNoCC { inputsFrom = [ config.packages.docs ]; };
+      packages = {
+        docs =
+          pkgs.runCommand "docs"
+            {
+              buildInputs = [
+                pkgs.python3.pkgs.mkdocs-material
+                pkgs.python3.pkgs.mkdocs-material.optional-dependencies.recommended
+              ];
+              files = pkgs.lib.fileset.toSource {
+                root = ../.;
+                fileset = pkgs.lib.fileset.unions [
+                  ../docs
+                  ../mkdocs.yml
+                ];
+              };
+            }
+            ''
+              cp --no-preserve=mode -r $files/* .
+              cp --no-preserve=mode ${config.packages.docs-json}/*.json docs
+              mkdocs build --strict --site-dir $out
+            '';
+        docs-linkcheck = pkgs.testers.lycheeLinkCheck rec {
+          extraConfig = {
+            include_mail = true;
+            include_verbatim = true;
           };
-        }
-        ''
-          cd $files
-          mkdocs build --strict --site-dir $out
-        '';
-    docs-linkcheck = pkgs.testers.lycheeLinkCheck rec {
-      extraConfig = {
-        exclude = [
-          "https://fonts.gstatic.com"
-          "https://monitoring.nix-community.org/alertmanager" # 401 behind auth
-        ];
-        include_mail = true;
-        include_verbatim = true;
-      };
-      remap = {
-        "https://nix-community.org" = site;
+          remap = {
+            "https://nix-community.org" = site;
+          };
+          site = config.packages.docs;
+        };
+        docs-json =
+          pkgs.runCommand "docs-json"
+            {
+              buildInputs = [ pkgs.jq ];
+              hosts = pkgs.writeText "hosts.json" (
+                builtins.toJSON (
+                  pkgs.lib.mapAttrs (_: x: {
+                    experimental-features = x.config.nix.settings.experimental-features or [ ];
+                    extra-platforms = x.config.nix.settings.extra-platforms or [ ];
+                    system-features = x.config.nix.settings.system-features or [ ];
+                    inherit (x.config.nixpkgs.hostPlatform) system;
+                    inherit (x.config.nix.settings) sandbox;
+                  }) (self.darwinConfigurations // self.nixosConfigurations)
+                )
+              );
+            }
+            ''
+              mkdir -p $out
+              for host in $(jq -r 'keys[]' $hosts); do
+                jq --arg host "$host" \
+                  '.[$host] | walk(if type == "array" then sort else . end)' \
+                  --sort-keys < $hosts > $out/$host.json
+              done
+            '';
       };
-      site = config.packages.docs;
     };
-  };
 }

docs/community-builders.md

@@ -18,6 +18,8 @@ aarch64-build-box.nix-community.org ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIG9uyfhy
 darwin-build-box.nix-community.org ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKMHhlcn7fUpUuiOFeIhDqBzBNFsbNqq+NpzuGX3e6zv
 ```
 
+See [here](./infrastructure.md#community-builders) for details about the hardware.
+
 ### Access
 
 We will grant access to well known members of the community, and people well known members in the community trust.

docs/continuous-integration.md

@@ -9,6 +9,8 @@ Both `aarch64-linux` and `x86_64-linux` have support for `kvm`/`nixos-test`.
 
 We only have limited build capacity for `*-darwin` so please don't use it excessively.
 
+See [here](./infrastructure.md#continuous-integration) for details about the hardware.
+
 #### Buildbot
 
 [https://buildbot.nix-community.org](https://buildbot.nix-community.org)

docs/infrastructure.md

@@ -7,6 +7,10 @@
 - RAM: 128GB DDR4 ECC
 - Drives: 2 x 1.92TB NVME
 
+```json
+--8<-- "docs/build01.json"
+```
+
 #### [`aarch64-build-box.nix-community.org`](./community-builders.md) - `build05`
 
 - Provider: Hetzner
@@ -15,6 +19,10 @@
 - RAM: 128GB DDR4 ECC
 - Drives: 2 x 960GB NVME
 
+```json
+--8<-- "docs/build05.json"
+```
+
 #### [`darwin-build-box.nix-community.org`](./community-builders.md) - `darwin01`
 
 - Provider: OakHost
@@ -23,6 +31,10 @@
 - RAM: 32GB
 - Drives: 1TB SSD
 
+```json
+--8<-- "docs/darwin01.json"
+```
+
 ### Continuous Integration
 
 #### [`CI builder`](./continuous-integration.md) - `build03`
@@ -33,6 +45,10 @@
 - RAM: 256GB DDR5 ECC
 - Drives: 2 x 1.92TB NVME
 
+```json
+--8<-- "docs/build03.json"
+```
+
 #### [`CI builder`](./continuous-integration.md) - `build04`
 
 - Provider: Hetzner
@@ -41,6 +57,10 @@
 - RAM: 128GB DDR4 ECC
 - Drives: 2 x 960GB NVME
 
+```json
+--8<-- "docs/build04.json"
+```
+
 #### [`CI builder`](./continuous-integration.md) - `darwin02`
 
 - Provider: OakHost
@@ -49,6 +69,10 @@
 - RAM: 32GB
 - Drives: 1TB SSD
 
+```json
+--8<-- "docs/darwin02.json"
+```
+
 ### Other
 
 #### [`R. RyanTM nixpkgs-update bot`](./update-bot.md) - `build02`
@@ -58,6 +82,10 @@
 - RAM: 128GB DDR4 ECC
 - Drives: 2 x 1.92TB NVME
 
+```json
+--8<-- "docs/build02.json"
+```
+
 #### [`Monitoring`](./monitoring.md) - `web02`
 
 - Provider: Gandi

flake.nix

@@ -54,6 +54,7 @@
       systems = import inputs.systems;
 
       imports = [
+        ./dev/docs.nix
         ./dev/effect-deploy.nix
         ./modules
         inputs.hercules-ci-effects.flakeModule
@@ -107,7 +108,6 @@
         }:
         {
           imports = [
-            ./dev/docs.nix
             ./dev/shell.nix
             ./terraform/shell.nix
           ];

mkdocs.yml

@@ -37,6 +37,8 @@ theme:
 markdown_extensions:
   - attr_list
   - md_in_html
+  - pymdownx.snippets
+  - pymdownx.superfences
   - toc:
       toc_depth: 0