max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-22 14:06:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

reword the experimental feature notice

Browse source 
- put the highlight box around all the relevant instructions
- simplify the wording
- make the link more prominent by using the whole phrase for the link text
This commit is contained in:
Valentin Gagarin 2023-11-30 21:59:08 +01:00
parent 39de819eda
commit 0301b8fc73
2 changed files with 35 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/manual/generate-settings.nix
View file

@ -31,18 +31,19 @@ let
experimentalFeatureNote = optionalString (experimentalFeature != null) '' experimentalFeatureNote = optionalString (experimentalFeature != null) ''
> **Warning** > **Warning**
>
> This setting is part of an > This setting is part of an
> [experimental feature](@docroot@/contributing/experimental-features.md). > [experimental feature](@docroot@/contributing/experimental-features.md).
>
To change this setting, you need to make sure the corresponding experimental feature, > To change this setting, make sure the
[`${experimentalFeature}`](@docroot@/contributing/experimental-features.md#xp-feature-${experimentalFeature}), > [`${experimentalFeature}` experimental feature](@docroot@/contributing/experimental-features.md#xp-feature-${experimentalFeature})
is enabled. > is enabled.
For example, include the following in [`nix.conf`](#): > For example, include the following in [`nix.conf`](@docroot@/command-ref/conf-file.md):
>
``` > ```
extra-experimental-features = ${experimentalFeature} > extra-experimental-features = ${experimentalFeature}
${setting} = ... > ${setting} = ...
``` > ```
''; '';
showDefault = documentDefault: defaultValue: showDefault = documentDefault: defaultValue:

48
doc/manual/generate-store-info.nix
View file

@ -1,6 +1,6 @@
let let
inherit (builtins) attrValues mapAttrs; inherit (builtins) attrValues mapAttrs;
inherit (import <nix/utils.nix>) concatStrings optionalString; inherit (import <nix/utils.nix>) concatStrings optionalString squash;
showSettings = import <nix/generate-settings.nix>; showSettings = import <nix/generate-settings.nix>;
in in
@ -10,36 +10,36 @@ let
showStore = name: { settings, doc, experimentalFeature }: showStore = name: { settings, doc, experimentalFeature }:
let let
result = squash ''
# ${name}
result = '' ${doc}
## ${name}
${doc} ${experimentalFeatureNote}
${experimentalFeatureNote} ## Settings
### Settings ${showSettings { prefix = "store-${slug}"; inherit inlineHTML; } settings}
'';
${showSettings { prefix = "store-${slug}"; inherit inlineHTML; } settings}
'';
# markdown doesn't like spaces in URLs # markdown doesn't like spaces in URLs
slug = builtins.replaceStrings [ " " ] [ "-" ] name; slug = builtins.replaceStrings [ " " ] [ "-" ] name;
experimentalFeatureNote = optionalString (experimentalFeature != null) '' experimentalFeatureNote = optionalString (experimentalFeature != null) ''
> **Warning** > **Warning**
> This store is part of an >
> [experimental feature](@docroot@/contributing/experimental-features.md). > This store is part of an
> [experimental feature](@docroot@/contributing/experimental-features.md).
To use this store, you need to make sure the corresponding experimental feature, >
[`${experimentalFeature}`](@docroot@/contributing/experimental-features.md#xp-feature-${experimentalFeature}), > To use this store, make sure the
is enabled. > [`${experimentalFeature}` experimental feature](@docroot@/contributing/experimental-features.md#xp-feature-${experimentalFeature})
For example, include the following in [`nix.conf`](#): > is enabled.
> For example, include the following in [`nix.conf`](@docroot@/command-ref/conf-file.md):
``` >
extra-experimental-features = ${experimentalFeature} > ```
``` > extra-experimental-features = ${experimentalFeature}
''; > ```
in result; '';
in result;
in concatStrings (attrValues (mapAttrs showStore storesInfo)) in concatStrings (attrValues (mapAttrs showStore storesInfo))