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: organize chapters into parts, and reduce toc depth (19.09) #71779

Merged
merged 7 commits into from Oct 23, 2019
Merged

doc: organize chapters into parts, and reduce toc depth (19.09) #71779

merged 7 commits into from Oct 23, 2019

Conversation

FRidh
Copy link
Member

@FRidh FRidh commented Oct 23, 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 @

@FRidh
doc: organize chapters into parts, and reduce toc depth
cda7d2b 
Reorganize the chapters into parts and reduce the TOC depth to make the
TOC useful again. The top-level TOC is very brief, but that is fine
because every part will have its own TOC.

Section titles of languages/frameworks are also simplified to just
the name of the language/framework.
@FRidh
doc: merge package notes and package-specific notes
3c21cd9 
Maybe there was an idea behind this separation, but looking at the
contents I don't see any reason for these being separate.
@FRidh
doc: split packages part into xml file per package
126c9e1
@FRidh
doc: move fetchers and trivial builders under builders
58b3278
@FRidh
doc: move image builders into new images chapter
f312907
@FRidh
doc: move overrides into separate chapter
8d3736b
@FRidh
doc: move fhs and mkShell under builders/special
3a4842f 
In my opinion Functions should only contain pure functions. These are
both meant to provide derivations so I put them under Builders. Don't
know exactly *where* to put them so "special" it is...
@FRidh FRidh merged commit 43968da into NixOS:release-19.09 Oct 23, 2019
@FRidh FRidh deleted the manual branch October 23, 2019 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
0.kind: enhancement 8.has: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@FRidh