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

codify terminology #263

Merged
merged 9 commits into from
Oct 10, 2022
Merged

codify terminology #263

merged 9 commits into from
Oct 10, 2022

Conversation

fricklerhandwerk
Copy link
Collaborator

@fricklerhandwerk fricklerhandwerk commented Jul 11, 2022

we observe confusion around terminology.

  • newcomers find it hard to distinguish all the things that are called Nix
  • Nix is a very generic term that is hard to search for online

this proposal is to introduce just enough structure to clearly distinguish concepts, and give names that are not wrong, without invalidating existing material. therefore it is strictly oriented around existing conventions.

it is not intended as an attempt to radically rename ecosystem components, even if that may be desirable for better readability and discoverability.

closes #275

CONTRIBUTING.md Outdated Show resolved Hide resolved
@nixos-discourse
Copy link

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

https://discourse.nixos.org/t/should-we-give-a-name-to-nix-on-non-nixos/21020/7

@fricklerhandwerk fricklerhandwerk changed the title codify nomenclature codify terminology Aug 16, 2022
Copy link

@blaggacao blaggacao left a comment

Choose a reason for hiding this comment

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

Since Nix is very fundamentally a source-based distribution mechanism, in my opinion, it makes sense to acknowledge that fact by relating glossary terms to sources. In this light, suggestions above.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@rapenne-s
Copy link
Member

rapenne-s commented Aug 16, 2022

Is it necessary to prefix every item with nix? At some point, it may be worth thinking about renaming some parts.

Even reading it, it's still confusing because it's mostly "nix [something]".

If I compare with Gentoo (the OS) built with Portage (the building tool / package manager) from ebuilds (packages definition), you don't mix anything.

But in this case, NixOS is built with Nix by running the nix cli on a nix file, it supports everything from the nixos modules collection and the nix packages collection.

@fricklerhandwerk
Copy link
Collaborator Author

@rapenne-s I agree, but I strongly doubt we can pull of a large renaming without doing a lot of damage. This proposal is to provide just enough structure to make sense of things, in a backwards compatible way, even if it all sounds redundant.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
fricklerhandwerk and others added 7 commits September 14, 2022 12:31
it's a more common term and hopefully easier to pronounce
Co-authored-by: Benoit de Chezelles <bew@users.noreply.github.com>
based on NixOS#275 (comment)

@edolstra proposed using "Nixpkgs" as a proper name

- this is not pronouncible from just reading it, but at least it's brief
  and unambiguous
  -> added pronounciation

@uningan pointed out Nix is more than just a package manager, but also
a built system.

- this is true, and probably we don't have to reflect that in the proper
  name
- also don't have to change anything if we keep Nix
  -> back to just Nix

multiple threads of discussion diverged into very broad proposals to
rename things, but the focus here should be on the smallest possible change to
improve clarity and get consensus on something at all.
  -> removed additional proposals, which are tangential
CONTRIBUTING.md Outdated Show resolved Hide resolved
@nixos-discourse
Copy link

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

https://discourse.nixos.org/t/tweag-nix-dev-update-35/21701/1

@fricklerhandwerk
Copy link
Collaborator Author

@edolstra @domenkozar @Mic92 @infinisil There seem to be no more objections, therefore I would merge this end of next week.

Copy link
Member

@infinisil infinisil left a comment

Choose a reason for hiding this comment

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

Looking good!

@domenkozar domenkozar merged commit 301be65 into NixOS:master Oct 10, 2022
davidak added a commit to davidak/nix.dev that referenced this pull request May 28, 2023
It is not part of the official terminology the nixos documentation team established in NixOS#263.

It was mixed in NixOS#380 and messed up the official status of the terms. This change fixes that!

It can be added again when we figured out what we mean by it (NixOS#464).
@fricklerhandwerk fricklerhandwerk deleted the nomenclature branch June 21, 2023 11:53
fricklerhandwerk pushed a commit to fricklerhandwerk/nix.dev that referenced this pull request Jul 13, 2023
It is not part of the official terminology the nixos documentation team established in NixOS#263.

It was mixed in NixOS#380 and messed up the official status of the terms. This change fixes that!

It can be added again when we figured out what we mean by it (NixOS#464).
fricklerhandwerk added a commit that referenced this pull request Jul 13, 2023
* Remove "reproducible" from glossary

It is not part of the official terminology the nixos documentation team established in #263.

It was mixed in #380 and messed up the official status of the terms. This change fixes that!

It can be added again when we figured out what we mean by it (#464).

---------

Co-authored-by: davidak <davidak@users.noreply.github.com>
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.

establish nomenclature
9 participants