nixos-homepage

nixos-homepage copied to clipboard

Introduce your stance

It's good to invite people to improve our pages/documentation. Having links to the GitHub sources in many places helps people find the source and reminds them that they too can contribute.

Describe the issue

I know that we have "declared in" and "source" links, but these are not as inviting as they should be and don't always link to master.

Edit on GitHub buttons could be added to

• [ ] the NixOS options search. Lookups should be based on the unstable index, because our workflow is not to forward port but to backport if necessary.
• [ ] the packages index, same considerations as above
• [ ] the main site, although this might be a bit too radical. Analogously, wikipedia doesn't allow editing all pages either.
• [ ] the manuals, at each location where a .md file is imported.

Perhaps other places too.

Page links Please enumerate the page links where to observe the issue.

Additional context Add any other context about the problem here.

While browsing for "editable" content, I found these stats about options going from 20.03 to 20.09

1119 options were added (61 new modules) 476 options removed 118 options were updated

Not sure how updated is counted but that seems too low. I would not expect an order of magnitude difference between additions and edits. It suggests that the documentation isn't improved very often.

• [ ] I already created a Pull Request

<! -- for small content changes, that can be improved as a drive-by contribution, we invite you to use github's direct online editing function -->

^ This issue agrees with the issue template.

I wanted to edit https://nixos.org/guides/building-and-running-docker-images.html but I can't find the source.

Note to self: add system = "x86_64-linux" to the example and link https://github.com/LnL7/nix-docker#running-as-a-remote-builder

Refs https://github.com/NixOS/nixpkgs/pull/115083

It's not in the guides folder https://github.com/NixOS/nixos-homepage/tree/master/guides

GitHub full text search didn't help either.

@garbas do you know where to find the dockerTools guide?

@roberth part of nix.dev

https://github.com/nix-dot-dev/nix.dev/blob/master/source/tutorials/building-and-running-docker-images.rst

That's interesting. I'm sure @domenkozar is on board with this but it is surprising and it's SEO-unfriendly to duplicate content across sites.

I have expressed that I'd like those to be linked instead of copied over.

Then the argument was that guides need to be on the same domain with the same styling (I don't think this matters at all, but I also don't want to go down this rabbit hole).

The result is there are many discrepancies, like complaints that guides are too opinionated (that's one of the reasons why nix.dev is a separate project anyway).

Another reason why it's a separate site is to avoid bikeshedding, so I'm fine with whatever is decided :)

What the heck? Open source doesn't mean it's a free-for-all. The least they should do is comply with the nix.dev licensing terms; to include attribution. Right now there's no mention of nix.dev at all.

It even says Copyright NixOS at the bottom of the page...

To be fair, I accepted what is currently there (and also changed license to be the same CC as nixos.org has so that it's easier to merge the content).

Would be nice to attribute the license indeed :)

With #903 there is no issue with identifying the source of the articles any more. Since @NixOS/documentation-team is working on migrating the manuals to nix.dev, and this issue is phrased very broadly, @roberth let's close it and open an issue on https://github.com/NixOS/nixos-search/ and https://github.com/NixOS/nix.dev/ respectively.