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

Check links in the manual #7541

Merged
merged 8 commits into from
Jan 10, 2023
Merged

Conversation

roberth
Copy link
Member

@roberth roberth commented Jan 3, 2023

  • is the idea good? has it been discussed by the Nix team?
  • unit tests
    • Part of the build
  • functional tests (tests/**.sh)
    • N/A
  • documentation in the manual
  • documentation in the code (if necessary; ideally code is already clear)
    • Makefile inline scripts are not conducive to such comments
      • So use individual commands instead of inline scripts
  • documentation in the commit message (why was this change made? for future reference when maintaining the code)
  • documentation in the changelog (to announce features and fixes to existing users who might have to do something to finally solve their problem, and to summarize the development history)
    • N/A

Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

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

This is really good, especially because it solves the problem of having to figure out where to point relative paths from in-code documentation thanks to the @docroot@ convention.

doc/manual/src/contributing/hacking.md Outdated Show resolved Hide resolved
doc/manual/src/contributing/hacking.md Outdated Show resolved Hide resolved
doc/manual/src/contributing/hacking.md Outdated Show resolved Hide resolved
doc/manual/src/contributing/hacking.md Outdated Show resolved Hide resolved
doc/manual/src/contributing/hacking.md Show resolved Hide resolved
src/libexpr/primops.cc Outdated Show resolved Hide resolved
@roberth roberth marked this pull request as ready for review January 3, 2023 10:39
@roberth roberth changed the title Check manual links Check links in the manual Jan 3, 2023
@fricklerhandwerk fricklerhandwerk added documentation contributor-experience Developer experience for Nix contributors labels Jan 3, 2023
@nixos-discourse
Copy link

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

https://discourse.nixos.org/t/2023-01-06-nix-team-meeting-minutes-21/24573/1

roberth and others added 8 commits January 10, 2023 22:30
mdbook-linkcheck is not consistent about its warning setting.
It disables some warnings, but not the warnings about lack of
fragment checking support; hence the extra filtering.
This way the links are clearly within the manual (ie not absolute paths),
while allowing snippets to reference the documentation root reliably,
regardless of at which base url they're included.
The targets I could find.
... before the link checking "output" was added, bumping the
html output into a subdirectory.
@roberth roberth force-pushed the check-manual-links branch from a987ec0 to 6ae4d76 Compare January 10, 2023 21:30
@roberth roberth enabled auto-merge January 10, 2023 21:31
@roberth roberth merged commit f58c301 into NixOS:master Jan 10, 2023
@nixos-discourse
Copy link

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

https://discourse.nixos.org/t/nix-team-report-2022-10-2023-03/27486/1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor-experience Developer experience for Nix contributors documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[chore] look into link checking for the manual
3 participants