From f417372fdc21ca7d8441f18d33933be60da7c5e7 Mon Sep 17 00:00:00 2001 From: ibizaman Date: Fri, 8 Dec 2023 10:36:22 -0800 Subject: [PATCH] move monitoring docs close to source --- docs/default.nix | 3 +++ docs/manual.md | 2 +- .../monitoring/docs}/assets/alert_rules_5xx_1.png | Bin .../monitoring/docs}/assets/alert_rules_5xx_2.png | Bin .../monitoring/docs}/assets/dashboards_Errors_1.png | Bin .../monitoring/docs}/assets/dashboards_Errors_2.png | Bin .../docs}/assets/dashboards_Performance_1.png | Bin .../docs}/assets/dashboards_Performance_2.png | Bin .../blocks/monitoring/docs}/assets/folder.png | Bin .../blocks/monitoring/docs}/default.md | 0 10 files changed, 4 insertions(+), 1 deletion(-) rename {docs/blocks/monitoring => modules/blocks/monitoring/docs}/assets/alert_rules_5xx_1.png (100%) rename {docs/blocks/monitoring => modules/blocks/monitoring/docs}/assets/alert_rules_5xx_2.png (100%) rename {docs/blocks/monitoring => modules/blocks/monitoring/docs}/assets/dashboards_Errors_1.png (100%) rename {docs/blocks/monitoring => modules/blocks/monitoring/docs}/assets/dashboards_Errors_2.png (100%) rename {docs/blocks/monitoring => modules/blocks/monitoring/docs}/assets/dashboards_Performance_1.png (100%) rename {docs/blocks/monitoring => modules/blocks/monitoring/docs}/assets/dashboards_Performance_2.png (100%) rename {docs/blocks/monitoring => modules/blocks/monitoring/docs}/assets/folder.png (100%) rename {docs/blocks/monitoring => modules/blocks/monitoring/docs}/default.md (100%) diff --git a/docs/default.nix b/docs/default.nix index bd0a18eb..619aec14 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -71,6 +71,8 @@ in stdenv.mkDerivation { nativeBuildInputs = [ nixos-render-docs ]; + # We include the parent so we get the documentation inside the root + # modules/ and demo/ folders. src = ./..; buildPhase = '' @@ -78,6 +80,7 @@ in stdenv.mkDerivation { mkdir -p demo cp -t . -r ../demo + cp -t . -r ../modules mkdir -p out/media mkdir -p out/highlightjs diff --git a/docs/manual.md b/docs/manual.md index c61febd2..db00cefd 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -8,7 +8,7 @@ preface.md ``` ```{=include=} chapters html:into-file=//blocks-monitoring.html -blocks/monitoring/default.md +modules/blocks/monitoring/docs/default.md ``` ```{=include=} chapters html:into-file=//demo-homeassistant.html diff --git a/docs/blocks/monitoring/assets/alert_rules_5xx_1.png b/modules/blocks/monitoring/docs/assets/alert_rules_5xx_1.png similarity index 100% rename from docs/blocks/monitoring/assets/alert_rules_5xx_1.png rename to modules/blocks/monitoring/docs/assets/alert_rules_5xx_1.png diff --git a/docs/blocks/monitoring/assets/alert_rules_5xx_2.png b/modules/blocks/monitoring/docs/assets/alert_rules_5xx_2.png similarity index 100% rename from docs/blocks/monitoring/assets/alert_rules_5xx_2.png rename to modules/blocks/monitoring/docs/assets/alert_rules_5xx_2.png diff --git a/docs/blocks/monitoring/assets/dashboards_Errors_1.png b/modules/blocks/monitoring/docs/assets/dashboards_Errors_1.png similarity index 100% rename from docs/blocks/monitoring/assets/dashboards_Errors_1.png rename to modules/blocks/monitoring/docs/assets/dashboards_Errors_1.png diff --git a/docs/blocks/monitoring/assets/dashboards_Errors_2.png b/modules/blocks/monitoring/docs/assets/dashboards_Errors_2.png similarity index 100% rename from docs/blocks/monitoring/assets/dashboards_Errors_2.png rename to modules/blocks/monitoring/docs/assets/dashboards_Errors_2.png diff --git a/docs/blocks/monitoring/assets/dashboards_Performance_1.png b/modules/blocks/monitoring/docs/assets/dashboards_Performance_1.png similarity index 100% rename from docs/blocks/monitoring/assets/dashboards_Performance_1.png rename to modules/blocks/monitoring/docs/assets/dashboards_Performance_1.png diff --git a/docs/blocks/monitoring/assets/dashboards_Performance_2.png b/modules/blocks/monitoring/docs/assets/dashboards_Performance_2.png similarity index 100% rename from docs/blocks/monitoring/assets/dashboards_Performance_2.png rename to modules/blocks/monitoring/docs/assets/dashboards_Performance_2.png diff --git a/docs/blocks/monitoring/assets/folder.png b/modules/blocks/monitoring/docs/assets/folder.png similarity index 100% rename from docs/blocks/monitoring/assets/folder.png rename to modules/blocks/monitoring/docs/assets/folder.png diff --git a/docs/blocks/monitoring/default.md b/modules/blocks/monitoring/docs/default.md similarity index 100% rename from docs/blocks/monitoring/default.md rename to modules/blocks/monitoring/docs/default.md