Merge pull request #1380 from cachix/work/keys/better-link

Better links for reference documents
cachix · Aug 12, 2024 · 14e51a0 · 14e51a0
2 parents 1b4b927 + 5c29740
commit 14e51a0
Show file tree

Hide file tree

Showing 91 changed files with 11 additions and 11 deletions.
diff --git a/devenv.nix b/devenv.nix
@@ -145,7 +145,7 @@
   scripts."devenv-generate-individual-docs" = {
     description = "Generate individual docs of all devenv modules";
     exec = ''
-      mkdir -p docs/{autogen-language-docs,autogen-service-docs,autogen-process-manager-docs}
+      mkdir -p docs/{supported-languages,supported-services,supported-process-managers}
 
       nix build --impure --extra-experimental-features 'flakes nix-command' --show-trace --print-out-paths '.#devenv-generate-individual-docs'
       cp -r --no-preserve=all result/docs/individual-docs/* docs/

diff --git a/docs/.pages b/docs/.pages
@@ -9,13 +9,13 @@ nav:
       - Scripts: scripts.md
       - Languages: 
         - Overview: languages.md
-        - Supported Languages: autogen-language-docs
+        - Supported Languages: supported-languages
       - Processes: 
         - Overview: processes.md
-        - Supported Process Managers: autogen-process-manager-docs
+        - Supported Process Managers: supported-process-managers
       - Services: 
         - Overview: services.md
-        - Supported Services: autogen-service-docs
+        - Supported Services: supported-services
       - Containers: containers.md
       - Binary Caching: binary-caching.md
       - Pre-Commit Hooks: pre-commit-hooks.md

diff --git a/docs/autogen-language-docs/ansible.md → docs/supported-languages/ansible.md b/docs/autogen-language-docs/ansible.md → docs/supported-languages/ansible.md
diff --git a/docs/autogen-language-docs/c.md → docs/supported-languages/c.md b/docs/autogen-language-docs/c.md → docs/supported-languages/c.md
diff --git a/docs/autogen-language-docs/clojure.md → docs/supported-languages/clojure.md b/docs/autogen-language-docs/clojure.md → docs/supported-languages/clojure.md
diff --git a/docs/autogen-language-docs/cplusplus.md → docs/supported-languages/cplusplus.md b/docs/autogen-language-docs/cplusplus.md → docs/supported-languages/cplusplus.md
diff --git a/docs/autogen-language-docs/crystal.md → docs/supported-languages/crystal.md b/docs/autogen-language-docs/crystal.md → docs/supported-languages/crystal.md
diff --git a/docs/autogen-language-docs/cue.md → docs/supported-languages/cue.md b/docs/autogen-language-docs/cue.md → docs/supported-languages/cue.md
diff --git a/docs/autogen-language-docs/dart.md → docs/supported-languages/dart.md b/docs/autogen-language-docs/dart.md → docs/supported-languages/dart.md
diff --git a/docs/autogen-language-docs/deno.md → docs/supported-languages/deno.md b/docs/autogen-language-docs/deno.md → docs/supported-languages/deno.md
diff --git a/docs/autogen-language-docs/dotnet.md → docs/supported-languages/dotnet.md b/docs/autogen-language-docs/dotnet.md → docs/supported-languages/dotnet.md
diff --git a/docs/autogen-language-docs/elixir.md → docs/supported-languages/elixir.md b/docs/autogen-language-docs/elixir.md → docs/supported-languages/elixir.md
diff --git a/docs/autogen-language-docs/elm.md → docs/supported-languages/elm.md b/docs/autogen-language-docs/elm.md → docs/supported-languages/elm.md
diff --git a/docs/autogen-language-docs/erlang.md → docs/supported-languages/erlang.md b/docs/autogen-language-docs/erlang.md → docs/supported-languages/erlang.md
diff --git a/docs/autogen-language-docs/fortran.md → docs/supported-languages/fortran.md b/docs/autogen-language-docs/fortran.md → docs/supported-languages/fortran.md
diff --git a/docs/autogen-language-docs/gawk.md → docs/supported-languages/gawk.md b/docs/autogen-language-docs/gawk.md → docs/supported-languages/gawk.md
diff --git a/docs/autogen-language-docs/gleam.md → docs/supported-languages/gleam.md b/docs/autogen-language-docs/gleam.md → docs/supported-languages/gleam.md
diff --git a/docs/autogen-language-docs/go.md → docs/supported-languages/go.md b/docs/autogen-language-docs/go.md → docs/supported-languages/go.md
diff --git a/docs/autogen-language-docs/haskell.md → docs/supported-languages/haskell.md b/docs/autogen-language-docs/haskell.md → docs/supported-languages/haskell.md
diff --git a/docs/autogen-language-docs/idris.md → docs/supported-languages/idris.md b/docs/autogen-language-docs/idris.md → docs/supported-languages/idris.md
diff --git a/docs/autogen-language-docs/java.md → docs/supported-languages/java.md b/docs/autogen-language-docs/java.md → docs/supported-languages/java.md
diff --git a/docs/autogen-language-docs/javascript.md → docs/supported-languages/javascript.md b/docs/autogen-language-docs/javascript.md → docs/supported-languages/javascript.md
diff --git a/docs/autogen-language-docs/jsonnet.md → docs/supported-languages/jsonnet.md b/docs/autogen-language-docs/jsonnet.md → docs/supported-languages/jsonnet.md
diff --git a/docs/autogen-language-docs/julia.md → docs/supported-languages/julia.md b/docs/autogen-language-docs/julia.md → docs/supported-languages/julia.md
diff --git a/docs/autogen-language-docs/kotlin.md → docs/supported-languages/kotlin.md b/docs/autogen-language-docs/kotlin.md → docs/supported-languages/kotlin.md
diff --git a/docs/autogen-language-docs/lean4.md → docs/supported-languages/lean4.md b/docs/autogen-language-docs/lean4.md → docs/supported-languages/lean4.md
diff --git a/docs/autogen-language-docs/lua.md → docs/supported-languages/lua.md b/docs/autogen-language-docs/lua.md → docs/supported-languages/lua.md
diff --git a/docs/autogen-language-docs/nim.md → docs/supported-languages/nim.md b/docs/autogen-language-docs/nim.md → docs/supported-languages/nim.md
diff --git a/docs/autogen-language-docs/nix.md → docs/supported-languages/nix.md b/docs/autogen-language-docs/nix.md → docs/supported-languages/nix.md
diff --git a/docs/autogen-language-docs/ocaml.md → docs/supported-languages/ocaml.md b/docs/autogen-language-docs/ocaml.md → docs/supported-languages/ocaml.md
diff --git a/docs/autogen-language-docs/odin.md → docs/supported-languages/odin.md b/docs/autogen-language-docs/odin.md → docs/supported-languages/odin.md
diff --git a/docs/autogen-language-docs/opentofu.md → docs/supported-languages/opentofu.md b/docs/autogen-language-docs/opentofu.md → docs/supported-languages/opentofu.md
diff --git a/docs/autogen-language-docs/pascal.md → docs/supported-languages/pascal.md b/docs/autogen-language-docs/pascal.md → docs/supported-languages/pascal.md
diff --git a/docs/autogen-language-docs/perl.md → docs/supported-languages/perl.md b/docs/autogen-language-docs/perl.md → docs/supported-languages/perl.md
diff --git a/docs/autogen-language-docs/php.md → docs/supported-languages/php.md b/docs/autogen-language-docs/php.md → docs/supported-languages/php.md
diff --git a/docs/autogen-language-docs/purescript.md → docs/supported-languages/purescript.md b/docs/autogen-language-docs/purescript.md → docs/supported-languages/purescript.md
diff --git a/docs/autogen-language-docs/python.md → docs/supported-languages/python.md b/docs/autogen-language-docs/python.md → docs/supported-languages/python.md
diff --git a/docs/autogen-language-docs/r.md → docs/supported-languages/r.md b/docs/autogen-language-docs/r.md → docs/supported-languages/r.md
diff --git a/docs/autogen-language-docs/racket.md → docs/supported-languages/racket.md b/docs/autogen-language-docs/racket.md → docs/supported-languages/racket.md
diff --git a/docs/autogen-language-docs/raku.md → docs/supported-languages/raku.md b/docs/autogen-language-docs/raku.md → docs/supported-languages/raku.md
diff --git a/docs/autogen-language-docs/robotframework.md → docs/supported-languages/robotframework.md b/docs/autogen-language-docs/robotframework.md → docs/supported-languages/robotframework.md
diff --git a/docs/autogen-language-docs/ruby.md → docs/supported-languages/ruby.md b/docs/autogen-language-docs/ruby.md → docs/supported-languages/ruby.md
diff --git a/docs/autogen-language-docs/rust.md → docs/supported-languages/rust.md b/docs/autogen-language-docs/rust.md → docs/supported-languages/rust.md
diff --git a/docs/autogen-language-docs/scala.md → docs/supported-languages/scala.md b/docs/autogen-language-docs/scala.md → docs/supported-languages/scala.md
diff --git a/docs/autogen-language-docs/shell.md → docs/supported-languages/shell.md b/docs/autogen-language-docs/shell.md → docs/supported-languages/shell.md
diff --git a/docs/autogen-language-docs/solidity.md → docs/supported-languages/solidity.md b/docs/autogen-language-docs/solidity.md → docs/supported-languages/solidity.md
diff --git a/docs/autogen-language-docs/standardml.md → docs/supported-languages/standardml.md b/docs/autogen-language-docs/standardml.md → docs/supported-languages/standardml.md
diff --git a/docs/autogen-language-docs/swift.md → docs/supported-languages/swift.md b/docs/autogen-language-docs/swift.md → docs/supported-languages/swift.md
diff --git a/docs/autogen-language-docs/terraform.md → docs/supported-languages/terraform.md b/docs/autogen-language-docs/terraform.md → docs/supported-languages/terraform.md
diff --git a/docs/autogen-language-docs/texlive.md → docs/supported-languages/texlive.md b/docs/autogen-language-docs/texlive.md → docs/supported-languages/texlive.md
diff --git a/docs/autogen-language-docs/typescript.md → docs/supported-languages/typescript.md b/docs/autogen-language-docs/typescript.md → docs/supported-languages/typescript.md
diff --git a/docs/autogen-language-docs/unison.md → docs/supported-languages/unison.md b/docs/autogen-language-docs/unison.md → docs/supported-languages/unison.md
diff --git a/docs/autogen-language-docs/v.md → docs/supported-languages/v.md b/docs/autogen-language-docs/v.md → docs/supported-languages/v.md
diff --git a/docs/autogen-language-docs/vala.md → docs/supported-languages/vala.md b/docs/autogen-language-docs/vala.md → docs/supported-languages/vala.md
diff --git a/docs/autogen-language-docs/zig.md → docs/supported-languages/zig.md b/docs/autogen-language-docs/zig.md → docs/supported-languages/zig.md
diff --git a/.../autogen-process-manager-docs/hivemind.md → docs/supported-process-managers/hivemind.md b/.../autogen-process-manager-docs/hivemind.md → docs/supported-process-managers/hivemind.md
diff --git a/docs/autogen-process-manager-docs/honcho.md → docs/supported-process-managers/honcho.md b/docs/autogen-process-manager-docs/honcho.md → docs/supported-process-managers/honcho.md
diff --git a/.../autogen-process-manager-docs/overmind.md → docs/supported-process-managers/overmind.md b/.../autogen-process-manager-docs/overmind.md → docs/supported-process-managers/overmind.md
diff --git a/...n-process-manager-docs/process-compose.md → ...orted-process-managers/process-compose.md b/...n-process-manager-docs/process-compose.md → ...orted-process-managers/process-compose.md
diff --git a/docs/autogen-service-docs/adminer.md → docs/supported-services/adminer.md b/docs/autogen-service-docs/adminer.md → docs/supported-services/adminer.md
diff --git a/docs/autogen-service-docs/blackfire.md → docs/supported-services/blackfire.md b/docs/autogen-service-docs/blackfire.md → docs/supported-services/blackfire.md
diff --git a/docs/autogen-service-docs/caddy.md → docs/supported-services/caddy.md b/docs/autogen-service-docs/caddy.md → docs/supported-services/caddy.md
@@ -153,7 +153,7 @@ path
 
 
 *Default:*
-` "/home/runner/work/devenv/devenv/.devenv/state/caddy" `
+` "/home/k3ys/sandbox/cachix/devenv/.devenv/state/caddy" `
 
 
 

diff --git a/docs/autogen-service-docs/cassandra.md → docs/supported-services/cassandra.md b/docs/autogen-service-docs/cassandra.md → docs/supported-services/cassandra.md
diff --git a/docs/autogen-service-docs/clickhouse.md → docs/supported-services/clickhouse.md b/docs/autogen-service-docs/clickhouse.md → docs/supported-services/clickhouse.md
diff --git a/docs/autogen-service-docs/cockroachdb.md → docs/supported-services/cockroachdb.md b/docs/autogen-service-docs/cockroachdb.md → docs/supported-services/cockroachdb.md
diff --git a/docs/autogen-service-docs/couchdb.md → docs/supported-services/couchdb.md b/docs/autogen-service-docs/couchdb.md → docs/supported-services/couchdb.md
diff --git a/docs/autogen-service-docs/dynamodb-local.md → docs/supported-services/dynamodb-local.md b/docs/autogen-service-docs/dynamodb-local.md → docs/supported-services/dynamodb-local.md
diff --git a/docs/autogen-service-docs/elasticmq.md → docs/supported-services/elasticmq.md b/docs/autogen-service-docs/elasticmq.md → docs/supported-services/elasticmq.md
diff --git a/docs/autogen-service-docs/elasticsearch.md → docs/supported-services/elasticsearch.md b/docs/autogen-service-docs/elasticsearch.md → docs/supported-services/elasticsearch.md
diff --git a/docs/autogen-service-docs/httpbin.md → docs/supported-services/httpbin.md b/docs/autogen-service-docs/httpbin.md → docs/supported-services/httpbin.md
diff --git a/docs/autogen-service-docs/influxdb.md → docs/supported-services/influxdb.md b/docs/autogen-service-docs/influxdb.md → docs/supported-services/influxdb.md
diff --git a/docs/autogen-service-docs/mailhog.md → docs/supported-services/mailhog.md b/docs/autogen-service-docs/mailhog.md → docs/supported-services/mailhog.md
diff --git a/docs/autogen-service-docs/mailpit.md → docs/supported-services/mailpit.md b/docs/autogen-service-docs/mailpit.md → docs/supported-services/mailpit.md
diff --git a/docs/autogen-service-docs/meilisearch.md → docs/supported-services/meilisearch.md b/docs/autogen-service-docs/meilisearch.md → docs/supported-services/meilisearch.md
diff --git a/docs/autogen-service-docs/memcached.md → docs/supported-services/memcached.md b/docs/autogen-service-docs/memcached.md → docs/supported-services/memcached.md
diff --git a/docs/autogen-service-docs/minio.md → docs/supported-services/minio.md b/docs/autogen-service-docs/minio.md → docs/supported-services/minio.md
diff --git a/docs/autogen-service-docs/mongodb.md → docs/supported-services/mongodb.md b/docs/autogen-service-docs/mongodb.md → docs/supported-services/mongodb.md
diff --git a/docs/autogen-service-docs/mysql.md → docs/supported-services/mysql.md b/docs/autogen-service-docs/mysql.md → docs/supported-services/mysql.md
diff --git a/docs/autogen-service-docs/nginx.md → docs/supported-services/nginx.md b/docs/autogen-service-docs/nginx.md → docs/supported-services/nginx.md
diff --git a/docs/autogen-service-docs/opensearch.md → docs/supported-services/opensearch.md b/docs/autogen-service-docs/opensearch.md → docs/supported-services/opensearch.md
diff --git a/...n-service-docs/opentelemetry-collector.md → ...orted-services/opentelemetry-collector.md b/...n-service-docs/opentelemetry-collector.md → ...orted-services/opentelemetry-collector.md
diff --git a/docs/autogen-service-docs/postgres.md → docs/supported-services/postgres.md b/docs/autogen-service-docs/postgres.md → docs/supported-services/postgres.md
diff --git a/docs/autogen-service-docs/rabbitmq.md → docs/supported-services/rabbitmq.md b/docs/autogen-service-docs/rabbitmq.md → docs/supported-services/rabbitmq.md
diff --git a/docs/autogen-service-docs/redis.md → docs/supported-services/redis.md b/docs/autogen-service-docs/redis.md → docs/supported-services/redis.md
diff --git a/docs/autogen-service-docs/temporal.md → docs/supported-services/temporal.md b/docs/autogen-service-docs/temporal.md → docs/supported-services/temporal.md
diff --git a/docs/autogen-service-docs/trafficserver.md → docs/supported-services/trafficserver.md b/docs/autogen-service-docs/trafficserver.md → docs/supported-services/trafficserver.md
diff --git a/docs/autogen-service-docs/typesense.md → docs/supported-services/typesense.md b/docs/autogen-service-docs/typesense.md → docs/supported-services/typesense.md
diff --git a/docs/autogen-service-docs/varnish.md → docs/supported-services/varnish.md b/docs/autogen-service-docs/varnish.md → docs/supported-services/varnish.md
diff --git a/docs/autogen-service-docs/vault.md → docs/supported-services/vault.md b/docs/autogen-service-docs/vault.md → docs/supported-services/vault.md
diff --git a/docs/autogen-service-docs/wiremock.md → docs/supported-services/wiremock.md b/docs/autogen-service-docs/wiremock.md → docs/supported-services/wiremock.md
diff --git a/flake.nix b/flake.nix
@@ -121,9 +121,9 @@
                                 languageDir=./languages
                                 serviceDir=./services
                                 processManagerDir=./process-managers
-                                mkdir -p $out/docs/individual-docs/autogen-language-docs
-                                mkdir -p $out/docs/individual-docs/autogen-service-docs
-                                mkdir -p $out/docs/individual-docs/autogen-process-manager-docs
+                                mkdir -p $out/docs/individual-docs/supported-languages
+                                mkdir -p $out/docs/individual-docs/supported-services
+                                mkdir -p $out/docs/individual-docs/supported-process-managers
                                 AUTOGEN_NOTICE="[comment]: # (Do not edit this file as it is autogenerated. Go to docs/individual-docs if you want to make edits.)"
 
                                 ${lib.concatStringsSep "\n" (lib.mapAttrsToList (key: options:  ''
@@ -136,7 +136,7 @@
                                     AUTOGEN_OPTIONS \
                                     "$content"
 
-                                    cp $file $out/docs/individual-docs/autogen-language-docs/${key}.md
+                                    cp $file $out/docs/individual-docs/supported-languages/${key}.md
 
                                 '') ( processedOptions languageOptions ))}
 
@@ -150,7 +150,7 @@
                                     AUTOGEN_OPTIONS \
                                     "$content"
 
-                                    cp $file $out/docs/individual-docs/autogen-service-docs/${key}.md
+                                    cp $file $out/docs/individual-docs/supported-services/${key}.md
 
                                 '') ( processedOptions serviceOptions ))}
 
@@ -164,7 +164,7 @@
                                     AUTOGEN_OPTIONS \
                                     "$content"
 
-                                    cp $file $out/docs/individual-docs/autogen-process-manager-docs/${key}.md
+                                    cp $file $out/docs/individual-docs/supported-process-managers/${key}.md
                                 '') ( processedOptions  processManagersOptions))}
 
               '';
Original file line number	Diff line number	Diff line change
Expand Up		@@ -153,7 +153,7 @@ path


		Default:
		` "/home/runner/work/devenv/devenv/.devenv/state/caddy" `
		` "/home/k3ys/sandbox/cachix/devenv/.devenv/state/caddy" `



Expand Down