git.iko.soy/typeable/nixpkgs
on master help sign in
Merge pull request #85681 from Beskhue/improve-descriptions

nixos/acme: improve some descriptions

commitaf5765b0dc424341c19a14bfbca5b98f6157cb75 authorMario Rodas <marsam@users.noreply.github.com> dateThu 23 Jul 2020, 00:03 (6 years ago) parent399b1778a061eb
1 file changed+11−11
nixos/modules/security/acme.nix+11−11
nixos/modules/security/acme.nix+11−11
@@ -23,16 +23,16 @@ let
2323 type = types.nullOr types.str;
2424 default = null;
2525 description = ''
26− ACME Directory Resource URI. Defaults to let's encrypt
26+ ACME Directory Resource URI. Defaults to Let's Encrypt's
2727 production endpoint,
28− https://acme-v02.api.letsencrypt.org/directory, if unset.
28+ <link xlink:href="https://acme-v02.api.letsencrypt.org/directory"/>, if unset.
2929 '';
3030 };
3131
3232 domain = mkOption {
3333 type = types.str;
3434 default = name;
35− description = "Domain to fetch certificate for (defaults to the entry name)";
35+ description = "Domain to fetch certificate for (defaults to the entry name).";
3636 };
3737
3838 email = mkOption {
@@ -103,7 +103,7 @@ let
103103 description = ''
104104 Key type to use for private keys.
105105 For an up to date list of supported values check the --key-type option
106− at https://go-acme.github.io/lego/usage/cli/#usage.
106+ at <link xlink:href="https://go-acme.github.io/lego/usage/cli/#usage"/>.
107107 '';
108108 };
109109
@@ -113,7 +113,7 @@ let
113113 example = "route53";
114114 description = ''
115115 DNS Challenge provider. For a list of supported providers, see the "code"
116− field of the DNS providers listed at https://go-acme.github.io/lego/dns/.
116+ field of the DNS providers listed at <link xlink:href="https://go-acme.github.io/lego/dns/"/>.
117117 '';
118118 };
119119
@@ -123,7 +123,7 @@ let
123123 Path to an EnvironmentFile for the cert's service containing any required and
124124 optional environment variables for your selected dnsProvider.
125125 To find out what values you need to set, consult the documentation at
126− https://go-acme.github.io/lego/dns/ for the corresponding dnsProvider.
126+ <link xlink:href="https://go-acme.github.io/lego/dns/"/> for the corresponding dnsProvider.
127127 '';
128128 example = "/var/src/secrets/example.org-route53-api-token";
129129 };
@@ -169,7 +169,7 @@ in
169169 (mkRemovedOptionModule [ "security" "acme" "production" ] ''
170170 Use security.acme.server to define your staging ACME server URL instead.
171171
172− To use the let's encrypt staging server, use security.acme.server =
172+ To use Let's Encrypt's staging server, use security.acme.server =
173173 "https://acme-staging-v02.api.letsencrypt.org/directory".
174174 ''
175175 )
@@ -207,9 +207,9 @@ in
207207 type = types.nullOr types.str;
208208 default = null;
209209 description = ''
210− ACME Directory Resource URI. Defaults to let's encrypt
210+ ACME Directory Resource URI. Defaults to Let's Encrypt's
211211 production endpoint,
212− <literal>https://acme-v02.api.letsencrypt.org/directory</literal>, if unset.
212+ <link xlink:href="https://acme-v02.api.letsencrypt.org/directory"/>, if unset.
213213 '';
214214 };
215215
@@ -230,8 +230,8 @@ in
230230 type = types.bool;
231231 default = false;
232232 description = ''
233− Accept the CA's terms of service. The default provier is Let's Encrypt,
234− you can find their ToS at https://letsencrypt.org/repository/
233+ Accept the CA's terms of service. The default provider is Let's Encrypt,
234+ you can find their ToS at <link xlink:href="https://letsencrypt.org/repository/"/>.
235235 '';
236236 };
237237