Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nixos-manual: link to sources #98563

Closed
wants to merge 1 commit into from
Closed

Conversation

@raboof
Copy link
Member

@raboof raboof commented Sep 23, 2020

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
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
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 ;).
Copy link
Contributor

@doronbehar doronbehar left a comment

I felt that missing just a few days ago :).

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.
Copy link
Contributor

@doronbehar doronbehar Sep 26, 2020

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.

Copy link
Member Author

@raboof raboof Sep 27, 2020

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.

Copy link
Contributor

@doronbehar doronbehar Sep 27, 2020

I understand the argument. I think we should make it inline with:

https://nixos.org/manual/nixpkgs/stable/#chap-contributing

@raboof
Copy link
Member Author

@raboof raboof commented Oct 22, 2020

never mind I guess

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants