Change project's self-description #575
Conversation
|
No objections from my side. Is this blocked by anything we should take care of to avoid confusion or wrong impressions? |
|
I think it's mostly about: is nix.dev only for Nix documentation? Or does/will it cover nixpkgs/nixos as well? And is documentation broad enough to include tutorials, howtos, etc, or should we mention those explicitly? |
We can resolve the ambiguity by referring to the "Nix ecosystem" encompassing all official projects (or a new term that emerged in the UX workshop last week, that was supposed to distinguish from all related but not official projects: Nix platform - @roberth @infinisil what do you think about that by the way?) For example: "Official documentation for the Nix ecosystem"
Broad enough for me. It's encompassed by Diataxis. |
|
I like Nix platform, it's going in the right direction IMO by pointing to the fact that it's an integrated set of components, which still have value on their own (e.g. nix without nixos, etc). Ecosystem as you say is broader and could include unofficial things like HM. |
|
If we decide to use "Nix platform", we should update the glossary right within this PR. Since it's completely new, people will otherwise (rightfully) get confused. |
Deploying with
|
| Latest commit: |
d76acbc
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6f5e3e3b.nix-dot-dev.pages.dev |
| Branch Preview URL: | https://official-about.nix-dot-dev.pages.dev |
|
@fricklerhandwerk what do you think of the definition? |
asymmetric
force-pushed
the
official-about
branch
from
11c7b44
to
7a01072
Compare
There was a problem hiding this comment.
I like it, but it's still very fresh. It's great we're finally pushing this issue (thanks a lot for taking care!), but before introducing a new term let's wait for what others think, especially @NixOS/documentation-team, @NixOS/marketing-team, and possibly @NixOS/nix-team. I don't want us to make such a far-reaching move without broad support.
|
I find "nix platform" a bit confusing to be honest. Nix ecosystem is something I'm used to, and makes sense as a collection of tightly related projects, but with the proposed descriptions I'm not sure what the "platform" is and how it differs from the "ecosystem" If I had to call anything the "nix platform" I instantly think of the nix CLI/tooling but that is quite different to what we're going for here. Also think along the lines of Platform as you'd find in PaaS (Platform as a Service) it tends to be more of a product offering like Elastic Beanstalk or Heroku |
|
I'm personally fine with the term. I think it's useful (it is indeed different from “Nix ecosystem”), and “platform” is not a bad term to describe it. Now this is largely out of scope for the Nix team, so I'll let more relevant people voice their opinion 😉 |
|
I don't want to say it's a bad term, it's just based on what's written here I personally don't really understand it, there might be a bit of extra detail that can be added to the description to make the distinction clear. Maybe I need to just let the term stew in my head for a while kind of like when there's a UI change you start off disliking but end up liking? 🤷 |
|
My preference is to keep "Nix ecosystem". The term "Nix platform" isn't widely used, and therefore people in the ecosystem won't have a shared understanding of what it is. |
There was a problem hiding this comment.
I think it's accurate to use "Nix Platform" to describe the officially supported Nix, NixOS and Nixpkgs projects. It's almost the literal platform the ecosystem is built upon.
We might want to take a look at https://github.com/orgs/NixOS/repositories at some point to figure out if it's more than just these three projects, in particular these stand out:
- https://github.com/NixOS/nixos-hardware (arguably part of NixOS though)
- https://github.com/NixOS/nixops (not really maintained anymore though)
- https://github.com/NixOS/hydra
|
Ok. The "nix platform" being official projects but everything else sitting as "nix ecosystem" makes sense. If that nuance could be added to the description/definition it would help if I was reading this |
@06kellyjac it is explained, in the glossary, perhaps you've missed that? Or do you mean that it should be mentioned in the homepage as well? If so, feel free to make a proposal, as I wouldn't know how :) |
@zmitchell I see your point now, but if we start pushing the term, eventually it will take root, IMO. So the idea is to start somewhere, with some level of consensus, and let it trickle through the different media. This assuming you agree that it's valuable to distinguish between official and unofficial subsets of the ecosystem, which is the main reason for coming up with another term beside ecosystem. |
Yeah I read the original glossary. The suggested change is pretty close to what I'm looking for actually yes. I'll add some comments there |
|
I don't have a strong opinion on this, if other people think "Nix platform" makes sense, please go ahead |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-06-05-documentation-team-meeting-notes-52/28937/1 |
|
Once the merge conflicts are fixed is this ready to merge or is more discussion required? |
|
@zmitchell as discussed during the meeting (see notes), @fricklerhandwerk proposed to wait until the foundation has capacity to weigh in on this. |
|
In my mind there's a slight clash with Nix being "cross-platform". (But certainly not a big deal to me. It's not like I have a term that I consider significantly better.) |
|
Discussed on documentation team meeting: "Getting things done with Nix" is quite agreeable, we should use that. @asymmetric could you fix it up? Then we'd merge and finally close #536! |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-06-26-documentation-team-meeting-notes-58/29666/1 |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-07-03-documentation-team-meeting-notes-60/29983/1 |
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
We don't need this definition anymore, since we're not using the term anywhere. This reverts commit ec0d566.
asymmetric
force-pushed
the
official-about
branch
from
a4fcc51
to
d76acbc
Compare
|
Rebased to fix conflicts. |
Feel free to propose better wording.
Closes #536