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

README: change to official NixOS wiki #2025

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Mic92
Copy link

@Mic92 Mic92 commented May 8, 2024

@Mic92 Mic92 requested a review from alerque as a code owner May 8, 2024 19:35
@Omikhleia Omikhleia added the documentation Documentation bug or improvement issue label May 8, 2024
@Omikhleia
Copy link
Member

Omikhleia commented May 10, 2024

Greetings,

  • SILE uses "conventional commits", so it seems to me that you should amend1 your commit so that it starts with chore(readme): Change to official NixOS wiki

  • Moreover the old wiki (https://nixos.wiki/wiki/Flakes#Installing_flakes, if I understand correctly), is also mentioned in the SILE manual (file documentation/c02-gettingstarted.sil). This would need to be fixed too, ideally is one more commit docs(manual): ...

  • Finally, there are a few .nix files in the repository mentioning https://nixos.wiki/wiki/Flakes#Using_flakes_project_from_a_legacy_Nix in comments. Shouldn't they be changed to use https://wiki.nixos.org/wiki/Flakes too? (But I can't find the referred section)

Footnotes

  1. E.g. git commit --amend, change the commit line and save, then git push --force

@@ -1,4 +1,4 @@
# https://nixos.wiki/wiki/Flakes#Using_flakes_project_from_a_legacy_Nix
# https://wiki.nixos.org/wiki/Flakes#Using_flakes_project_from_a_legacy_Nix
Copy link
Member

Choose a reason for hiding this comment

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

Unless mistaken, there does not seem to be a section "Using flakes project from a legacy Nix" any longer -- the links redirects me to the top of that wiki page. I don't know Nix enough to guess whether this is important or not (regarding the package code that follows here) or even if the comment has any interest being kept (?)

Copy link
Member

Choose a reason for hiding this comment

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

This wiki title was changed in May 2023 https://nixos.wiki/index.php?title=Flakes&diff=next&oldid=9498

Merely renamed = it's now https://wiki.nixos.org/wiki/Flakes#Using_flakes_with_stable_Nix would we want to keep it.

Not sure the internal title hash should be kept though ;)

@Omikhleia
Copy link
Member

Omikhleia commented May 10, 2024

N.B. I'm not a maintainer - I've approved the PR in order for CI the tests to be run and reported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation bug or improvement issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants