nixos-manual: link to sources #98563
Closed
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
I wanted to contribute to the nixos-manual but it took me a while to figure out where it sources were. This should make that easier ;).
doronbehar
reviewed
Sep 26, 2020
| The NixOS manual is maintained as part of the | ||
| <link xlink:href="https://github.com/nixos/nixpkgs">nixpkgs</link> collection. | ||
| You can find the sources and documentation on how to build them in | ||
| the <link xlink:href="https://github.com/nixos/nixpkgs/tree/master/nixos/doc/manual">nixos/doc/manual</link> directory. |
There was a problem hiding this comment.
Maybe instead of this, we should transfer the not too long contents of the README from there to here, and put in the README instead:
Transferred to: <URL>
?
It should save future contributors a few clicks.
There was a problem hiding this comment.
I think it's nice to keep it in the README - to make a contribution you'll have to check out the nixpkgs collection anyway, and once you know where to find it having the exact command right there instead of having to look at the docs themselves is more convenient.
There was a problem hiding this comment.
I understand the argument. I think we should make it inline with:
|
never mind I guess |
10 tasks
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.
Motivation for this change
I wanted to contribute to the nixos-manual but it took me a while to figure out
where it sources were. This should make that easier ;).
Things done
sandboxinnix.confon non-NixOS linux)nix-shell -p nixpkgs-review --run "nixpkgs-review wip"./result/bin/)nix path-info -Sbefore and after)