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

link to nix.dev for installation docs #1141

Closed
wants to merge 1 commit into from

Conversation

mightyiam
Copy link
Member

Another small step toward showing users the way into nix.dev.

Copy link
Member

@garbas garbas left a comment

Choose a reason for hiding this comment

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

I'm 👎 for this change since both pages contain the same information.

I assume this is the area where "tensions" between docs and marketing team arise. We need to agree what is in the domain of either team. I'm not sure how to structure this discussion, but any idea is welcome. Maybe starting with a simple call would be a start and we can see where it will take us.

I'm not saying that docs team shouldn't document how to install Nix, especially the advance/detailed version of the installation. For the happy path I think this should stay on the main website. But lets discuss this further...

@fricklerhandwerk
Copy link
Contributor

I argue we should do this for at least two reasons:

  • We currently still have at least three places where installation is shown.

    In the past months there was at least one instance where this was super annoying: someone had a very good change that made the shell command compatible with fish, and we had to update those three places in different repos, and missed the fourth one. Much later I removed the one from the Nix README which now points to nix.dev.

    We'll likely have to update it again and again if we move forward with the DetSys installer. I'm also considering pointing people to the same Nix release that is shipped with NixOS, because using Home Manager, where Nix is pinned to that version in NixOS, can break fresh installs that have a newer Nix. So there will be churn.

    Let's have one place for the happy path (nix.dev is on a good way to provide the complete happy path) and one for all the details (that's the Nix manual).

  • The @NixOS/marketing-team is objectively much less active than Nix maintainers and the documentation team. I would rather have you focus on your priorities rather than running this kind of day-to-day noise by you.

  • We're already moving all the Nix-specific documentation, including the manual, to nix.dev, and all of that is actively maintained. Let's just continue this, it seems to work. I would very much like to see nixos.org eventually expand on NixOS, because we don't really have anyone taking care of that and no other obvious place to put that information except for the NixOS manual (and that still needs a lot of love before one can work on it for real).

@garbas
Copy link
Member

garbas commented Nov 2, 2023

I argue we should do this for at least two reasons:

* We currently still have at least three places where installation is shown.
  In the past months there was at least one instance where this was super annoying: someone had a very good change that made the shell command compatible with `fish`, and we had to update those three places in different repos, and missed the fourth one. Much later I removed the one from the Nix README which now points to nix.dev.

I agree there should be one place for this and that place should be on the nixos.org website and detailed instructions in the documentation.

  We'll likely have to update it again and again if we move forward with the DetSys installer. I'm also considering pointing people to the same Nix release that is shipped with NixOS, because using Home Manager, where Nix is pinned to that version in NixOS, can break fresh installs that have a newer Nix. So there will be churn.

That can be easily changed in current setup. We currently follow what is released by the Nix team. I don't mind changing that.

  Let's have one place for the happy path (nix.dev is on a good way to provide the complete happy path) and one for all the details (that's the Nix manual).

I disagree nix.dev should be the place for this. But I also think nix.dev should be a redirect to nixos.org and that the docs subdomain should be used to not confuse the user that that is documentation.

* The @NixOS/marketing-team is objectively much less active than Nix maintainers and the documentation team. I would rather have you focus on your priorities rather than running this kind of day-to-day noise by you.

I don't consider this day-to-day noise. I consider this fundamental disagreement in direction. That is why I called for a call where we could align our idea and directions.

* We're already moving all the Nix-specific documentation, including the manual, to nix.dev, and all of that is actively maintained. Let's just continue this, it seems to work. I would very much like to see nixos.org eventually expand on NixOS, because we don't really have anyone taking care of that and no other obvious place to put that information except for the NixOS manual (and that still needs a lot of love before one can work on it for real).

I think this is our main point of disagreement and I think you know it, since we discussed it many times. As I wrote I'd like discuss the direction we are taking here since I fundamentally disagree with it.

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-11-02-documentation-team-meeting-notes-91/34938/1

@infinisil
Copy link
Member

https://nixos.org/download.html also contains info on installing NixOS, notably even with hashes. This is not on the nix.dev page, so we can't do this anyways for now

@fricklerhandwerk
Copy link
Contributor

fricklerhandwerk commented Nov 7, 2023

Hm. All of this is quite inconsistent. While we should continue improving in small steps, it would be really, really good if we could all work together on the overall idea for both nixos.org and nix.dev or whatever all of this will eventually turn out to be.

We'll have a world-class UX expert available to do just that for two days. @garbas it would be vital if you attended and I've been inviting you for more than half a year, @refroni will surely help making that possible.

@garbas garbas deleted the branch NixOS:master April 2, 2024 07:51
@garbas garbas closed this Apr 2, 2024
@mightyiam mightyiam deleted the install-link-nix-dev branch April 2, 2024 08:10
@mightyiam
Copy link
Member Author

Thank you.

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.

5 participants