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.

Sign up for GitHub

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

Jump to bottom

Doc: various improvements NixOS and Nixpkgs manuals #72157

Merged
merged 5 commits into from Oct 30, 2019
Merged

Doc: various improvements NixOS and Nixpkgs manuals #72157

merged 5 commits into from Oct 30, 2019

Conversation

FRidh
Copy link
Member

@FRidh FRidh commented Oct 28, 2019

Motivation for this change
Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • 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 nix-review --run "nix-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.
Notify maintainers

cc @

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/nixcon-2019-documentation-task-force-meeting-outcome/4551/2

@FRidh
nixpkgs manual: various improvements in introduction
fca1600 
- rename to preface to be inline with NixOS manual
- refer to other manuals
- use https
- change example channel to 19.09
@FRidh
nixos manual: reduce toc depth
faf9785 
to reduce the amount of information presented.
@FRidh
nixos manual: move preface into own file
c2d7006
@FRidh
nixos manual: have a toc for each part and chapter
2fef053 
to be inline with the Nixpkgs manual. This makes navigating to
particular sections easier.
@FRidh
nixos manual: refer to nix and nixpkgs manuals
bf9b761
roosemberth
roosemberth approved these changes Oct 28, 2019
View reviewed changes
Copy link
Contributor

@roosemberth roosemberth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't judge the flag change in manualXsltprocOptions, but everything else looks good to me.

@FRidh FRidh merged commit 91a7140 into NixOS:master Oct 30, 2019
@FRidh FRidh deleted the doc branch October 30, 2019 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@roosemberth roosemberth roosemberth approved these changes

Assignees
No one assigned
Labels
0.kind: enhancement 6.topic: nixos 8.has: documentation 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@FRidh @nixos-discourse @roosemberth