1
0
Fork 0
mirror of https://github.com/NixOS/nix.dev.git synced 2024-10-18 00:06:26 -04:00
Commit graph

958 commits

Author SHA1 Message Date
Valentin Gagarin 3b5fee627c update contributing guides
- clarify a few phrases
- move Open Collective link to the top
- add section headings for easier navigation
- add a few details on contacting people
2024-02-05 13:42:29 +01:00
Valentin Gagarin 22bedeaba0
front page: Who is Nix for? (#872)
* front page: Who is Nix for?

For at least two years there were ongoing debates about the target
audience of the Nix ecosystem. Nix maintainers did not manage to
converge on a statement [0]. The marketing team is explicitly focusing
on software developers [1], and the documentation team was supposed to
align with that from the very beginning [2].

What was missing so far was what we mean by "software developers".
Arguably, it encompasses a particular mind set about how to deal with
computers and enough time to learn things.

And while for documentation it matters most *what* the software is doing
rather than *who* it is made for (or by), the ecosystem is a community
effort, and people matter [3]. So far, we haven't really identified the
(eventual) boundaries of this community (at least I don't know of any
serious attempt), which also plays into the definition of a target
audience. Yet, in practice, not every contribution, not every question
or comment is treated equally, and this has reasons in our implicit
assumptions about who belongs.

This is an attempt to draw such a boundary that is not arbitrary, and
neither to narrow nor too wide. The goal is, as always, to help
Nix beginners set realistic expectations for their journey.

The list of occupations/interests who may benefit from Nix is based on
the 2022 [4] and 2023 [5] community surveys.

[0]: https://github.com/NixOS/nix/pull/7156
[1]: 76d42a052d/community/teams/marketing.tt (L89)
[2]: https://discourse.nixos.org/t/2022-06-15-documentation-team-meeting-notes-1/20004
[3]: https://discourse.nixos.org/t/zurich-23-05-zhf-hackathon-and-workshop-report/29093#ux-workshop-21
[4]: https://discourse.nixos.org/t/2022-nix-survey-results/18983
[5]: https://discourse.nixos.org/t/nix-community-survey-2023-results/33124

Co-authored-by: Daniel Sidhion <DanielSidhion@users.noreply.github.com>
2024-02-02 01:29:40 +01:00
Silvan Mosberger a505a3b066
Merge pull request #871 from fricklerhandwerk/email-subscription
remove email subscription form
2024-01-31 22:48:25 +01:00
Silvan Mosberger 5bc6e4046b
Merge pull request #870 from MasonM/patch-1
Fix unquoted URL in "Nix language basics"
2024-01-31 22:32:31 +01:00
Valentin Gagarin c9ed694ea8 NixOS tutorials: add next steps 2024-01-31 02:39:45 +01:00
Valentin Gagarin 747c3c7060 reorder NixOS tutorials
it makes more sense to start with the most innocent ones, where
everything runs in a VM.
2024-01-31 02:39:45 +01:00
nbelakovski 596d9db532
Update packaging-existing-software.md (#888)
As it was written, I thought we'd have to do more work to supply fetchzip, but the next invokation of nix-build seems to call fetchzip without any definition errors so I assume the error is in the documentation.
2024-01-30 20:18:50 +01:00
Valentin Gagarin a295a4dae1
fix broken reference (#889) 2024-01-30 12:32:03 +00:00
Valentin Gagarin 41ad39d8c2
clean up the Reference side bar (#885)
- use more neutral phrasing
- add nix-community, a lot of stuff going on there
- put the Glossary on top
2024-01-29 05:54:05 +01:00
Valentin Gagarin a11222eaec
add the NixOS Foundation YouTube channel to the videos list (#884) 2024-01-29 05:53:41 +01:00
Valentin Gagarin 9c12897c8f
fix up language in python environment guide (#882) 2024-01-29 01:44:42 +00:00
Valentin Gagarin e6c1fb1b14
move automatic environments up, add next steps (#881)
automatically entering the shell is the next logical step, especially if
we have turned it on and off multiple times in a row.
2024-01-29 02:42:49 +01:00
Valentin Gagarin a1c683aabb
move shell.nix tutorial up (#879)
it doesn't make sense that we continue with reproducibility becuase we
haven't seen lookup paths yet.
2024-01-29 02:42:40 +01:00
Valentin Gagarin cfa14f780a
update the FAQ on packaging (#883)
* update the FAQ on packaging

Co-authored-by: Silvan Mosberger <github@infinisil.com>
2024-01-29 01:41:51 +00:00
Valentin Gagarin cf94730f93
show nix-shell --run (#886)
* show nix-shell --run

it's quite useful and not necessarily obvious without reading reference documentation

Co-authored-by: Silvan Mosberger <github@infinisil.com>
2024-01-29 01:41:04 +00:00
Silvan Mosberger 5f1eea5bc2
Merge pull request #880 from fricklerhandwerk/wording
reword shell.nix tutorial introduction
2024-01-29 01:17:43 +01:00
Valentin Gagarin be612d5d12 reword shell.nix tutorial introduction
make shorter sentences and drop the key message about sharing
declarative environments
2024-01-28 20:00:12 +01:00
Valentin Gagarin b0a8a39fce highlight recommendation to use search.nixos.org
this way it's easier to find and probably also remember
2024-01-28 19:52:26 +01:00
Valentin Gagarin 75eceb50cd
small wording improvements (#877) 2024-01-28 18:30:34 +00:00
Valentin Gagarin 41f580f488 remove email subscription form
historically it still points to Cachix and not to a community-owned
instance. at the moment there is no regular community newsletter, which
would certainly include updates about documentation. we can add it back
once such a thing exists.
2024-01-26 21:54:21 +01:00
Mason Malone 6f56eda69a
Fix unquoted URL in "Nix language basics"
I'm a newbie, so I might be missing something, but the use of an unquoted URL here seems like it goes against the "Best Practice" page (https://nix.dev/guides/best-practices#urls), which says to always quote URLs.
2024-01-25 17:57:50 -08:00
Moraxyc 22b3a861cb
fix: typo
add ;
2024-01-22 12:13:35 +08:00
Valentin Gagarin 4f9862fdb9
disable linkcheck for GitHub anchor links (#859)
apparently it got (a lot) worse and GitHub doesn't render README files
statically any more.

this obviates the need of additional instructions.
2024-01-15 10:16:39 +00:00
Valentin Gagarin 0669665b42
simplify config.guess line (#858) 2024-01-07 10:08:50 +00:00
Alexander Groleau 143801d9ae
Merge pull request #854 from fricklerhandwerk/fix-noop-faq
remove no-op command in troubleshooting advice
2024-01-05 19:35:28 -08:00
Henrik Karlsson 35909232d3 fix for issue with host platform determination
cross compilation tutorial.
2024-01-05 21:55:58 +00:00
Valentin Gagarin 15dfbcf6c3 remove no-op command in troubleshooting advice
`nix-store --init` doesn't actually do anything [0] and is not even
documented in the Nix manual

[0]: 9651034dc2/src/nix-store/nix-store.cc (L736-L744)
2024-01-05 18:50:50 +01:00
Grégoire Paris 02f47d8a46
Refer to the tags page
The releases page is empty, and that might confuse people.
2023-12-28 15:02:05 +01:00
Carl Thomé c5d7eab39d
nix-generate-config -> nixos-generate-config 2023-12-26 14:12:53 +01:00
amirreza8002 36f1df3008
updated channel version (#848)
22.11 to 23.11
2023-12-26 10:28:34 +00:00
Silvan Mosberger 840f7ff50a File sets: Improve a sentence
It was confusing before
2023-12-22 21:29:02 +01:00
Silvan Mosberger 4ebcad8b0d File sets: Update note on gitTracked
Now that https://github.com/NixOS/nixpkgs/pull/273893 is merged, the
previous note isn't accurate anymore.
2023-12-22 21:28:58 +01:00
Jeff Huffman e3f4d7be86
add FAQ entry on how to run non-nix executables (#832) 2023-12-11 11:39:21 +01:00
Anthony Camarillo 876483a1f4
fix grammar and punctuation in declarative-shell.md (#834) 2023-12-08 01:11:52 +00:00
ET 824d81db97
fix missing word "in" 2023-12-05 14:24:11 +01:00
Robert Hensing 9cc2ddd16a
Merge pull request #764 from fricklerhandwerk/add-manuals
host Nix reference manual on nix.dev
2023-12-04 17:10:45 +01:00
Valentin Gagarin 68ded85b87 NixOS 23.11 was released 2023-12-04 16:52:49 +01:00
worktheclock 5b898ae819
Deploying NixOS using Terraform grammar check (#220) 2023-12-03 01:08:59 +00:00
Brian McGillion 2d6276114d
tutorials: Map Module (#820)
* tutorial: Propagate previous geocode changes

Propagate the changes made in a previous code snippet to this code
snippet. Primarily fixing the poorly referenced ``${geocode``.

* tutorial: Fix requestParams for path.nix

Adjust the functionality to reference geocode correctly and
also to make sure of the correct escaping formats.

Signed-off-by: Brian McGillion <bmg.avoin@gmail.com>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-12-01 23:51:34 +01:00
Silvan Mosberger cdf282de95 file-sets: Use hasExt for fileFilter
Now that https://github.com/NixOS/nixpkgs/pull/266362 is merged
2023-12-01 14:49:08 +01:00
Silvan Mosberger 0c688e044f file-sets: Use stable references
Now that 23.11 is released
2023-12-01 14:49:08 +01:00
Valentin Gagarin b29081d5c6
fix typography (#822) 2023-12-01 00:57:48 +01:00
Daniel R 6946cb0e2e
move question on rechecking binary cache to a Nix recipe (#808)
* mv question -f faqs -t nix-recipes

* add nix-recipes to page index and fix hierarchy

* change question to statement

* rephrase a few sentences and add links

* move the question to troubleshooting

* fix broken link

---------

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-30 16:41:18 +01:00
Valentin Gagarin 755e949a53
reduce the sharing dependencies tutorial to a guide (#778)
* shorten the sharing dependencies article to a guide

the contents do not really warrant a full-blown tutorial

* use an example with an explicit build-time dependency

* fix typo

* link `inputsFrom` to Nixpkgs manual
2023-11-30 16:17:35 +01:00
Brian McGillion b58466875c
tutorial: Fix the markers to build and concatenate (#816)
The current code has a number of issues.

1. realising the code results in:

``
markers=$(geocode 'New York') size=640x640 scale=2 zoom=7 ...
        ^-------------------^ SC2046 (warning): Quote this to prevent
        word splitting.
``

2.
``
$(geocode ${lib.escapeShellArg marker.location})"
``

Assumes that geocode has been added to the PATH so replace with

``
${config.scripts.geocode}/bin/geocode
``

as per previous examples.

3.
``
  in "markers=${ lib.concatStringsSep "\\|" attributes}";
in builtins.map paramForMarker config.map.markers;
``

The ordering of this actually creates multiple ``[markers =]``
parameters and does not use the concatenation string to join the
attributes together (in effect there is only 1 attribute per call) to
map, and 1 new ``marker`` created.

Signed-off-by: Brian McGillion <bmg.avoin@gmail.com>
2023-11-28 21:30:28 +01:00
Ming 791eb47e44
Show option to enable hardware acceleration (#809)
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Henrik <i97henka@gmail.com>
2023-11-27 16:59:49 +01:00
olaf 1a404f203e
vm improve reproducible command and 23.11 (#807)
* better reproducable command and 23.11

Co-authored-by: Henrik <i97henka@gmail.com>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-27 16:39:04 +01:00
Yannis Charalambidis cbc1b2e95e
Fix typo (#814) 2023-11-27 12:03:01 +01:00
Brian McGillion 327c100954
tutorials: fix passing paramaters to geocode (#812)
* tutorials: fix passing paramaters to geocode

When running the package as-is the following error occurs

``geocode: line 7: $1: unbound``

This is caused because ``scripts.geocode`` does not pass the parameters
down to the wrapped script ``geocode``.

Signed-off-by: Brian McGillion <bmg.avoin@gmail.com>
2023-11-27 07:42:07 +01:00
Valentin Gagarin f587e1d1cf use sentence case for titles consistently 2023-11-27 07:31:32 +01:00