doc: improve fetchers overview, deduplicate readme content, follow doc conventions #297654
Conversation
DanielSidhion
force-pushed
the
update-fetchers
branch
from
cfd11e9
to
3ddf992
Compare
ofborg
bot
added
10.rebuild-darwin: 0
10.rebuild-linux: 1-10
10.rebuild-linux: 1
labels
|
Started reviewing in docs team meeting today. This is a rabbit hole, because there is overlapping documentation on updating FOD hashes that ended up in contributor documentation, where it arguably shouldn't be. There are also repetitions of the same mantra in various other places. Ideally we'd merge all of that in the manual's fetcher section, and link to it from everywhere else. I'll push a few commits to improve the wording on the new stuff, but recommend splitting out the reference documentation in a different PR to get some of that work merged already. |
|
@DMills27 and me went all the way and closed the rabbit hole. But it still needs to be split to be reviewable. |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2024-03-28-documentation-team-meeting-notes-115/42329/1 |
DanielSidhion
force-pushed
the
update-fetchers
branch
2 times, most recently
from
1fc4499
to
5ae1b53
Compare
Co-authored-by: Dominic Mills-Howell <[email protected]>
Co-authored-by: Dominic Mills-Howell <[email protected]>
update wording in the contributors docs Co-authored-by: Dominic Mills-Howell <[email protected]>
this may be better suited for the `fetchurl` reference, but I'd prefer just rendering that information into the manual. for now, because - contributor documentation encourages mirrors - we can expect contributors to dig into the source - linking source files is trivial in in-code documentation we leave it there. Co-authored-by: Dominic Mills-Howell <[email protected]>
also improve the language a bit, and add links Co-authored-by: Dominic Mills-Howell <[email protected]>
DanielSidhion
force-pushed
the
update-fetchers
branch
from
5ae1b53
to
349353a
Compare
DanielSidhion
changed the title
|
@fricklerhandwerk @lolbinarycat: I followed @fricklerhandwerk's suggestion and split this PR into two. Did a bit of git history rewriting to get only the relevant changes in this PR, and #300429 has the fetchurl changes. @fricklerhandwerk - I made some changes and reworded some stuff on top of your changes, please take a look at the comments from my review to understand the reasoning. Requesting your review and @lolbinarycat's and I'm hoping we can agree on a merge soon 😊 Thank you all for the reviews, I feel this has turned out much better with your involvement! |
DanielSidhion
force-pushed
the
update-fetchers
branch
from
349353a
to
1901a88
Compare
Co-authored-by: lolbinarycat <[email protected]> Co-authored-by: Valentin Gagarin <[email protected]>
DanielSidhion
force-pushed
the
update-fetchers
branch
from
01a9d0b
to
defeadf
Compare
Description of changes
This PR starts my work to update and improve the chapter on fetchers in the Nixpkgs manual. It adds more explanations on the overview of the chapter, moves content from the contributor README into the manual, and deduplicates information.
NOTE: this PR started as a change of the fetchers overview AND updating the documentation for
fetchurl. After a lot of reviewing, we decided to split this PR into two. The PR concerns the description above. The second PR is #300429 and concerns only with updating the documentation forfetchurl.Things done
nix.conf? (See Nix manual)sandbox = relaxedsandbox = truenix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)Add a 👍 reaction to pull requests you find important.