summary refs log tree commit diff
path: root/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2022-08-15 07:16:25 +0200
committerpennae <82953136+pennae@users.noreply.github.com>2022-08-19 22:40:58 +0200
commit6039648c50c7c0858b5e506c6298773a98e0f066 (patch)
tree5421b3c36609e710c85b43d92dc3b830f6a1385b /nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
parent7e7d68a250f75678451cd44f8c3d585bf750461e (diff)
downloadnixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar.gz
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar.bz2
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar.lz
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar.xz
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar.zst
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.zip
nixos/*: automatically convert option docs
Diffstat (limited to 'nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix')
-rw-r--r--nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix18
1 files changed, 9 insertions, 9 deletions
diff --git a/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix b/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
index 7437242043e..83518344b36 100644
--- a/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
+++ b/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
@@ -103,15 +103,15 @@ let
         defaultText = literalExpression ''baseDirectory + "/secrets"'';
       };
       clusterJoinTokenPath = mkOption {
-        description = ''
+        description = lib.mdDoc ''
           Location of the cluster-join-token.key file.
 
           You can retrieve the contents of the file when creating a new agent via
-          <link xlink:href="https://hercules-ci.com/dashboard"/>.
+          <https://hercules-ci.com/dashboard>.
 
           As this value is confidential, it should not be in the store, but
           installed using other means, such as agenix, NixOps
-          <literal>deployment.keys</literal>, or manual installation.
+          `deployment.keys`, or manual installation.
 
           The contents of the file are used for authentication between the agent and the API.
         '';
@@ -120,28 +120,28 @@ let
         defaultText = literalExpression ''staticSecretsDirectory + "/cluster-join-token.key"'';
       };
       binaryCachesPath = mkOption {
-        description = ''
+        description = lib.mdDoc ''
           Path to a JSON file containing binary cache secret keys.
 
           As these values are confidential, they should not be in the store, but
           copied over using other means, such as agenix, NixOps
-          <literal>deployment.keys</literal>, or manual installation.
+          `deployment.keys`, or manual installation.
 
-          The format is described on <link xlink:href="https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/"/>.
+          The format is described on <https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/>.
         '';
         type = types.path;
         default = config.staticSecretsDirectory + "/binary-caches.json";
         defaultText = literalExpression ''staticSecretsDirectory + "/binary-caches.json"'';
       };
       secretsJsonPath = mkOption {
-        description = ''
+        description = lib.mdDoc ''
           Path to a JSON file containing secrets for effects.
 
           As these values are confidential, they should not be in the store, but
           copied over using other means, such as agenix, NixOps
-          <literal>deployment.keys</literal>, or manual installation.
+          `deployment.keys`, or manual installation.
 
-          The format is described on <link xlink:href="https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/"/>.
+          The format is described on <https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/>.
         '';
         type = types.path;
         default = config.staticSecretsDirectory + "/secrets.json";