!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

419 Members
Discussion about documentation improvements around the Nix ecosystem86 Servers

Load older messages


SenderMessageTime
12 Mar 2024
@dioprz:matrix.orgDiego changed their display name from dioprz to Diego.04:41:03
13 Mar 2024
@ktemkin:katesiria.org@ktemkin:katesiria.org changed their display name from Kate Temkin to [K]ate Temkin.02:56:13
@danielsidhion:nixos.devdanielsidhionJust saw https://github.com/NixOS/nixos-homepage/issues/1251 and wanted to check - is anyone already taking any action to bring the manuals back to the previous appearance? If not, I'll get started looking into that13:06:09
* @infinisil:matrix.orginfinisil isn't 13:14:12
14 Mar 2024
@federicodschonborn:matrix.org@federicodschonborn:matrix.org left the room.02:04:32
@danielsidhion:nixos.devdanielsidhion Draft PR to fix the stylesheet situation: https://github.com/NixOS/nixpkgs/pull/295847
Automatic header link buttons are still not there, because I need to extend nixos-render-docs more to allow that. Regardless of it, I appreciate anyone who can check out that PR, build the manuals (nix build .#htmlDocs.nixpkgsManual and nix build .#htmlDocs.nixosManual) and inspect the new styles and let me know if they see anything that needs fixing
10:47:43
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host

Question what outputs of our documentation do exist ?

Someone confirm / disagree with this list?

NixOS manual

Web
man page
epub

nixpkgs manual

Web
epub
11:53:00
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host Is there a specific reason, why there is no attribute like pkgs.docs.<output> at all? Wouldn't it be nice if our manual could be build as part of our package collection? 12:05:52
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * Is there a specific reason, why there is no attribute like pkgs.docs.<output> at all? Wouldn't it be nice if our manuals could be build as part of our package collection? 12:06:05
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostOr is that just because nobody added them yet.12:06:31
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * Is there a specific reason, why there is no attribute like pkgs.docs.<output> at all? Wouldn't it be nice if our manuals could be built as part of our package collection? 12:06:41
@picnoir:alternativebit.fr@picnoir:alternativebit.fr joined the room.12:07:06
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * Is there a specific reason, why there is no attribute like pkgs.docs.<output> at all? Wouldn't it be nice if our manuals could be built as part of our package collection? This would make it easier to answer the "outputs" question. 12:08:02
@picnoir:alternativebit.fr@picnoir:alternativebit.fr

Hey, I just stumbled upon this:

At some point we agreed to move the manuals to nix.dev

https://github.com/NixOS/nixos-homepage/issues/1251#issuecomment-1994193106

Not sure what is the best place to discuss this. Obviously not the above issue :)

I'd like to voice some concern about that: there's a lot of hyperlinks pointing to the manual on the web. Doing so will break those for little benefit.

12:09:00
@picnoir:alternativebit.fr@picnoir:alternativebit.fr *

Hey, I just stumbled upon this:

At some point we agreed to move the manuals to nix.dev

https://github.com/NixOS/nixos-homepage/issues/1251#issuecomment-1994193106

Not sure what is the best place to discuss this. Obviously not the above issue :) So let's go with this matrix channel.

I'd like to voice some concern about that: there's a lot of hyperlinks pointing to the manual on the web. Doing so will break those for little benefit.

12:09:17
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * Or is that just because nobody added them yet. (Some are in flake.nix it seems but not in the pkgs itself) 12:10:13
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host * Or is that just because nobody added them yet. (Web outputs are in flake.nix it seems but not in the pkgs itself) 12:10:49
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @picnoir:alternativebit.fr

Hey, I just stumbled upon this:

At some point we agreed to move the manuals to nix.dev

https://github.com/NixOS/nixos-homepage/issues/1251#issuecomment-1994193106

Not sure what is the best place to discuss this. Obviously not the above issue :) So let's go with this matrix channel.

I'd like to voice some concern about that: there's a lot of hyperlinks pointing to the manual on the web. Doing so will break those for little benefit.

I think this matrix channel is always best for asking about documentation concerns.
12:18:41
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host

Picnoir: can you give some more details:

there's a lot of hyperlinks pointing to the manual on the web

What exact links, do you mean on the nixos website or in nix.dev?

the manual on the web.

Do you mean all the manuals? Or the nixpkgs manual ? or the nixos manual ?

12:22:01
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host *

Picnoir: can you give some more details:

there's a lot of hyperlinks pointing to the manual on the web

What exact links, do you mean on the nixos website or in nix.dev?

the manual on the web.

Do you mean all the manuals? Or the nixpkgs manual ? or the nixos manual ?

12:22:58
@picnoir:alternativebit.fr@picnoir:alternativebit.frI'm mostly talking about links living on blog posts and overall pages not controlled by the documentation team.12:23:03
@picnoir:alternativebit.fr@picnoir:alternativebit.fr * I'm mostly talking about links living on blog posts, wikis and overall pages not controlled by the documentation team.12:23:08
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host *

Picnoir: can you give some more details:

there's a lot of hyperlinks pointing to the manual on the web

What exact links, do you mean on the nixos website or in nix.dev?

the manual on the web.

Do you mean all the manuals? Or the nixpkgs manual ? or the nixos manual ?

12:23:27
@picnoir:alternativebit.fr@picnoir:alternativebit.frAnd yes, all three main manuals: Nix, NixOS and Nixpkgs12:23:27
@picnoir:alternativebit.fr@picnoir:alternativebit.frNix for the language bit12:23:35
@picnoir:alternativebit.fr@picnoir:alternativebit.frNixOS for the modules configurations.12:23:40
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostAh okay understood.12:23:54
@picnoir:alternativebit.fr@picnoir:alternativebit.frNixpkgs for the language-specific build systems.12:23:54
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host

Good concern. Implementing a simple redirection endpoint is quite hard. because most of the manuals are just one single page behind a single url.
Anchor tags #section-name are not sent to the server. This means it is essentially impossible to redirect from the old link to a new location.
Because from a server perspective

https://nixos.org/manual/nixpkgs/stable/#__placeA__

is exactly the same as

https://nixos.org/manual/nixpkgs/stable/#__placeB__

12:28:55
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host

When a URL with an anchor tag is accessed, the browser uses the tag to scroll to a specific section of the page without making a server request for the anchor. The server only receives the part of the URL preceding the #.

12:30:37

Show newer messages


Back to Room ListRoom Version: 6