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

Update anchor to recursive sets in nix manual. #152

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

wathiede
Copy link

@wathiede wathiede commented Sep 1, 2020

No description provided.

@nlewo
Copy link
Member

nlewo commented Sep 5, 2020

Do you know how the recursive set ID is generated in the Nix manual?
I'm not sure this ID is actually stable.
Maybe we should first explicitly set this anchor in the Nix manual.

@jtojnar
Copy link
Contributor

jtojnar commented Sep 6, 2020

Yeah, it is non-deterministic. And Nix manual has been ported to Markdown so all links will be broken now anyway 🙀

@wathiede
Copy link
Author

wathiede commented Sep 7, 2020

Is the version live at https://nixos.org/manual/nix/stable/ the 'ported to Markdown' version, or an 'old' version?

I ran https://github.com/linkchecker/linkchecker and pointed it to https://nixos.org/manual/nix/stable/ with the following config:

[output]
status=1
fileoutput = text,csv 
[text]
filename=linkchecker-out.txt
[gml]
[dot]
[csv]
filename=linkchecker-out.csv
[sql]
[html]
[blacklist]
[xml]
[gxml]
[sitemap]
[checking]
[filtering]
checkextern=1
[authentication]
[AnchorCheck]

It reports 44 broken links/anchors, which isn't too bad. If the version live at https://nixos.org/manual/nix/stable/ is the markdown version, I'm happy to submit some PRs to https://github.com/NixOS/nix to add stable anchors to the things currently pointing to unstable anchors, and clean up all the rest (it looks like there's a number of links that go through a redirect from /nixpkgs/manual/ to /manual/nixpgs/stable/ and linkchecker doesn't like this).

This PR started as something I saw broken while reading through the pills, but I'm happy to do the larger cleanup if you want.

If the markdown version isn't what is live at https://nixos.org/manual/nix/stable/ then maybe there's a much bigger breakage coming, and I'll leave that cleanup to whomever is rolling out the port to markdown.

@jtojnar
Copy link
Contributor

jtojnar commented Sep 7, 2020

NixOS/nix#3857 has only been merged recently so it is not available on the website AFAIK. Unfortunately it will break all links.

@wathiede
Copy link
Author

wathiede commented Sep 7, 2020

Ok, sounds like this change isn't very useful. Thanks for the additional context and link.

@jtojnar
Copy link
Contributor

jtojnar commented May 16, 2021

Perhaps we should point it to the unstable manual: https://nixos.org/manual/nix/unstable/expressions/language-constructs.html#recursive-sets

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants