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

Jump to bottom

doc: explicit Markdown anchors for top-level headings; remove metadata #108147

Merged
merged 1 commit into from Jan 1, 2021
Merged

doc: explicit Markdown anchors for top-level headings; remove metadata #108147

merged 1 commit into from Jan 1, 2021

Conversation

ryantm
Copy link
Member

@ryantm ryantm commented Jan 1, 2021 •
edited

I used the existing anchors generated by Docbook, so the anchor part
should be a no-op. This could be useful depending on the
infrastructure we choose to use, and it is better to be explicit than
rely on Docbook's id generating algorithms.

I got rid of the metadata segments of the Markdown files, because they
are outdated, inaccurate, and could make people less willing to change
them without speaking with the author.

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.

@ryantm ryantm requested a review from FRidh as a code owner January 1, 2021 17:47
@ryantm ryantm marked this pull request as draft January 1, 2021 17:47
@ryantm ryantm force-pushed the doc-cleanup branch 2 times, most recently from e087bec to fa7d719 Compare January 1, 2021 18:00
@ryantm ryantm changed the title doc: add anchors for Markdown sections; other fixes doc: explicit anchors for Markdown sections; other fixes Jan 1, 2021
@ryantm
doc: explicit Markdown anchors for top-level headings; remove metadata
b8344f9 
I used the existing anchors generated by Docbook, so the anchor part
should be a no-op. This could be useful depending on the
infrastructure we choose to use, and it is better to be explicit than
rely on Docbook's id generating algorithms.

I got rid of the metadata segments of the Markdown files, because they
are outdated, inaccurate, and could make people less willing to change
them without speaking with the author.
@ryantm ryantm changed the title doc: explicit anchors for Markdown sections; other fixes doc: explicit Markdown anchors for top-level headings; remove metadata Jan 1, 2021
@ryantm ryantm requested a review from jtojnar January 1, 2021 18:07
@ryantm ryantm marked this pull request as ready for review January 1, 2021 18:08
@ryantm ryantm merged commit dd6c0ef into NixOS:master Jan 1, 2021
@ryantm ryantm deleted the doc-cleanup branch June 26, 2021 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jtojnar jtojnar jtojnar approved these changes

@FRidh FRidh Awaiting requested review from FRidh FRidh is a code owner

Assignees
No one assigned
Labels
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
2 participants
@ryantm @jtojnar