!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

374 Members
Discussion about documentation improvements around the Nix ecosystem89 Servers

Load older messages


SenderMessageTime
23 Sep 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
am I right in assuming nix+nixpkgs+nixos manuals and wiki.nixos.org have a lot of overlap in people contributing?
*

Eh, not that much. There are like 2-3 regular contributors who have touched all of them, but otherwise these are mostly disjoint groups as far as I can tell.

I mean, it's complicated. Define "a lot". There's not that many people working on documentation overall.

21:20:30
@fricklerhandwerk:matrix.orgfricklerhandwerk *

Eh, not that much. There are like 2-3 regular contributors who have touched all of them, but otherwise these are mostly disjoint groups as far as I can tell. I may be wrong.

I mean, it's complicated. Define "a lot". There's not that many people working on documentation overall.

21:20:53
@phanirithvij:matrix.orgloudgolemI found wiki to be easier to contribute to definitely21:21:24
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
maybe a single gha which checks external links among all manuals + home-pages + wiki-dump could work?
They all have very different update cycles, and running the checks in some other location from where the source is modified will just lead to people having to jump hoops. Had that with the Nix manual, please don't.
21:21:56
@phanirithvij:matrix.orgloudgolemok so gha per repo then, tested on corresponding stable manuals and sites and each repo can adjust the run frequency per its release cycle21:25:43
@phanirithvij:matrix.orgloudgolemthis doesn't need an rfc does it?21:28:50
@phanirithvij:matrix.orgloudgolem

I'm also interested in things like this https://discourse.nixos.org/t/nix-ecosystem-mind-map/28682/17
mindmaps, landscape, map-of-github, awesome-lists etc.

  • are the graphviz graphs in that thread maintained anywhere? say in some unofficial toy repo?
  • also nixos-landscape has been offline for a long time, that's a bummer

Another thing I'm interested in is to visualize/map nixpkgs health, i.e. how many packages are fresh, maintainer activity, most maintainted packages, packages without maintainers, long inactive maintainers etc. all of these clearly visible somewhere like nixpkgs.health. I see rfc 180 which adresses a few of these.

21:37:17
@phanirithvij:matrix.orgloudgolem *

I'm also interested in things like this https://discourse.nixos.org/t/nix-ecosystem-mind-map/28682/17
mindmaps, landscape, map-of-github, awesome-lists etc.

  • are the graphviz graphs in that thread maintained anywhere? say in some unofficial toy repo?
  • also nixos-landscape has been offline for quite a while, that's a bummer

Another thing I'm interested in is to visualize/map nixpkgs health, i.e. how many packages are fresh, maintainer activity, most maintainted packages, packages without maintainers, long inactive maintainers etc. all of these clearly visible somewhere like nixpkgs.health. I see rfc 180 which adresses a few of these.

21:37:33
@phanirithvij:matrix.orgloudgolem *

I'm also interested in things like this https://discourse.nixos.org/t/nix-ecosystem-mind-map/28682/17
mindmaps, landscape, map-of-github, awesome-lists etc.

  • are the graphviz graphs in that thread maintained anywhere? say in some unofficial toy repo?
  • also nixos-landscape has been unreachable for quite a while, that's a bummer

Another thing I'm interested in is to visualize/map nixpkgs health, i.e. how many packages are fresh, maintainer activity, most maintainted packages, packages without maintainers, long inactive maintainers etc. all of these clearly visible somewhere like nixpkgs.health. I see rfc 180 which adresses a few of these.

21:38:56
@phanirithvij:matrix.orgloudgolem *

I'm also interested in things like this https://discourse.nixos.org/t/nix-ecosystem-mind-map/28682/17
mindmaps, landscape, map-of-github, awesome-lists etc.

  • are the graphviz graphs in that thread maintained anywhere? say in some unofficial toy repo?
  • also nixos-landscape has been inaccesible for quite a while, that's a bummer

Another thing I'm interested in is to visualize/map nixpkgs health, i.e. how many packages are fresh, maintainer activity, most maintainted packages, packages without maintainers, long inactive maintainers etc. all of these clearly visible somewhere like nixpkgs.health. I see rfc 180 which adresses a few of these.

21:39:06
@phanirithvij:matrix.orgloudgolem *

I'm also interested in things like this https://discourse.nixos.org/t/nix-ecosystem-mind-map/28682/17
mindmaps, landscape, map-of-github, awesome-lists etc.

  • are the graphviz graphs in that thread maintained anywhere? say in some unofficial personal repo?
  • also nixos-landscape has been inaccesible for quite a while, that's a bummer

Another thing I'm interested in is to visualize/map nixpkgs health, i.e. how many packages are fresh, maintainer activity, most maintainted packages, packages without maintainers, long inactive maintainers etc. all of these clearly visible somewhere like nixpkgs.health. I see rfc 180 which adresses a few of these.

21:39:29
@phanirithvij:matrix.orgloudgolem *

I'm also interested in things like this https://discourse.nixos.org/t/nix-ecosystem-mind-map/28682/17
mindmaps, landscape, map-of-github, awesome-lists etc.

  • are the graphviz graphs in that thread maintained anywhere? say in some unofficial personal repo?
  • also nixos-landscape has been inaccesible for quite a while, that's a bummer

Another thing I'm interested in is to visualize/map nixpkgs health, i.e. how many packages are fresh, maintainer activity, most maintainted packages, packages without maintainers, long time inactive maintainers etc. all of these clearly visible somewhere like nixpkgs.health. I see rfc 180 which adresses a few of these.

21:40:04
@phanirithvij:matrix.orgloudgolemrepology statistics could be useful too21:41:21
@phanirithvij:matrix.orgloudgolem going to bed, I'll see about the linkchecks via testers.lycheeLinkCheck across all these repos tomorrow 21:42:44
24 Sep 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org

I'm also interested in things like this https://discourse.nixos.org/t/nix-ecosystem-mind-map/28682/17
mindmaps, landscape, map-of-github, awesome-lists etc.

  • are the graphviz graphs in that thread maintained anywhere? say in some unofficial personal repo?
  • also nixos-landscape has been inaccesible for quite a while, that's a bummer

Another thing I'm interested in is to visualize/map nixpkgs health, i.e. how many packages are fresh, maintainer activity, most maintainted packages, packages without maintainers, long time inactive maintainers etc. all of these clearly visible somewhere like nixpkgs.health. I see rfc 180 which adresses a few of these.

For data wrangling, you may be interested in https://github.com/Nix-Security-WG/nix-security-tracker

There's a full DB model of Nixpkgs metadata and a worker for periodic evaluations. (The end game of this would be Hydra dumping all the information directly into the database for everyone to build tools around.)

00:34:33
@phanirithvij:matrix.orgloudgolem
In reply to @infinisil:matrix.org
ryantm: I guess especially @pennae, who has been saying a lot that nixos-render-docs can already render with multiple pages with some small changes to the code. Furthermore Johannes Kirschbauer @hsjobeki and danielsidhion who have been investigating existing docs rendering tools to see if we could maybe not roll our own tooling at all. Your PR introduces yet another custom-built tool 😅
has anything been done for rendering docs in multiple pages since this discussion?
07:51:46
@phanirithvij:matrix.orgloudgolemwould be cool if the epub build were fixed too07:52:38
@phanirithvij:matrix.orgloudgolem@johannes.kirschbauer:scs.ems.host is there a noogle matrix channel?08:00:49
@johannes.kirschbauer:scs.ems.hostJohannes Kirschbauer @hsjobeki
In reply to @phanirithvij:matrix.org
has anything been done for rendering docs in multiple pages since this discussion?

As far as i am aware no. Pennae seems to do lix now. nixos-render-docs is now kind of unmaintained?
Multipage rendering can be done, and it should be a straight forward task.
Here are the steps that i have in my head rn.

  • build a table of track references (currently anchors)

  • split the manual during rendering into mutliple output pages (and where each reference is located)

  • make sure the references point to the correct subpage in output

  • write a client side redirect script for people having the old references

08:01:29
@johannes.kirschbauer:scs.ems.hostJohannes Kirschbauer @hsjobeki
In reply to @phanirithvij:matrix.org
@johannes.kirschbauer:scs.ems.host is there a noogle matrix channel?
No. But you can ask questions here as well i guess
08:02:29
@phanirithvij:matrix.orgloudgolemin the readme it is mentioned pagefind is only available in the production build08:03:07
@johannes.kirschbauer:scs.ems.hostJohannes Kirschbauer @hsjobeki danielsidhion: Is also kind of afk since ~springtime havent heard anything from him 08:03:24
@phanirithvij:matrix.orgloudgolemif I wish to self host noogle locally do I need pagefind08:03:26
@johannes.kirschbauer:scs.ems.hostJohannes Kirschbauer @hsjobekiPagefind is the search engine, so yes, if you want the search.08:04:25
@johannes.kirschbauer:scs.ems.hostJohannes Kirschbauer @hsjobeki "Production build" means npm run build 08:04:57
@johannes.kirschbauer:scs.ems.hostJohannes Kirschbauer @hsjobekiIts a completely static page, you can selfhost it.08:05:15
@phanirithvij:matrix.orgloudgolemok I'll try it out08:05:48
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host

As far as i am aware no. Pennae seems to do lix now. nixos-render-docs is now kind of unmaintained?
Multipage rendering can be done, and it should be a straight forward task.
Here are the steps that i have in my head rn.

  • build a table of track references (currently anchors)

  • split the manual during rendering into mutliple output pages (and where each reference is located)

  • make sure the references point to the correct subpage in output

  • write a client side redirect script for people having the old references

getpsyched is currently working exactly on this under my supervision. It will take a while to get there, the devil is in the details.
09:15:49
@johannes.kirschbauer:scs.ems.hostJohannes Kirschbauer @hsjobeki fricklerhandwerk:
Another thing that i'd like to get rid of are these include blocks in the nixpkgs/nixos docs. Because the overall structure can only be perceived from a recursive parser but not from a human. Which makes structural maintance/changes hard to understand.
09:29:38
@johannes.kirschbauer:scs.ems.hostJohannes Kirschbauer @hsjobekiJust asking if i this would hit some right spot.09:30:42

Show newer messages


Back to Room ListRoom Version: 6