Start cross-referencing experimental features #8174
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fricklerhandwerk
approved these changes
Apr 6, 2023
Ericson2314
force-pushed
the
gloss-xp-features-note-installables
branch
2 times, most recently
from
9159e7e
to
69c0000
Compare
Ericson2314
changed the title
Ericson2314
added a commit
to obsidiansystems/nix
that referenced
this pull request
Apr 10, 2023
Fix NixOS#8162 This is somewhat hard to observe until NixOS#8174 is merged, fixing the accidental hiding of experimental features that aren't currently enabled, but the fix is technically orthogonal.
8 tasks
Ericson2314
added a commit
to obsidiansystems/nix
that referenced
this pull request
Apr 11, 2023
Fix NixOS#8162 This is somewhat hard to observe until NixOS#8174 is merged, fixing the accidental hiding of experimental features that aren't currently enabled, but the fix is technically orthogonal.
Ericson2314
force-pushed
the
gloss-xp-features-note-installables
branch
from
69c0000
to
4ab7055
Compare
8 tasks
fricklerhandwerk
approved these changes
Apr 13, 2023
Ericson2314
commented
Apr 14, 2023
Ericson2314
commented
Apr 14, 2023
- Create a glossary entry for experimental features. - Have the man page experimental feature notice link `nix-commmand`. (Eventually this should be programmed, based on whether the command is experimental, and if so what experimental feature does it depend on.) - Document which installables depend on which experimental features. I tried to use the same style (bold warning and block quote) that the top of the man page uses. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Ericson2314
force-pushed
the
gloss-xp-features-note-installables
branch
from
50183b1
to
d93e76f
Compare
|
Thanks @fricklerhandwerk. I accepted all your changes and found a few more cases of it linking the glossary not page, and updated them accordingly. With all changes accepted and two approving reviews, I have set this to automerge :). |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/tweag-nix-dev-update-47/27387/1 |
|
This issue has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/tweag-nix-dev-update-47/27387/1 |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/this-month-in-nix-docs-2-april-2023/27899/1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Create a glossary entry for experimental features.
Have the man page experimental feature notice link
nix-commmand.(Eventually this should be programmed, based on whether the command is experimental, and if so what experimental feature does it depend on.)
Document which installables depend on which experimental features.
I tried to use the same style (bold warning and block quote) that the top of the man page uses.
Motivation
We want to make clear what parts of the CLI are unstable and why.
If per draft RFC NixOS/rfcs#136 we end up stabilizing the CLI before flakes, it is especially important to document flakes things as such so they aren't confused with any new CLI bits that are newly stable.
Context
depnds on #7798
Checklist for maintainers
Maintainers: tick if completed or explain if not relevant
tests/**.shsrc/*/teststests/nixos/*Priorities
Add 👍 to pull requests you find important.