Henrik
2c3083cf32
Update source/contributing/documentation.md
...
Co-authored-by: Alexander Groleau <alex@proof.construction>
2023-07-17 16:25:45 +01:00
Henrik
dd2d348513
Update source/contributing/documentation.md
...
Co-authored-by: Alexander Groleau <alex@proof.construction>
2023-07-17 16:24:22 +01:00
Henrik
056d4f2938
Update source/contributing/documentation.md
...
Co-authored-by: Alexander Groleau <alex@proof.construction>
2023-07-17 16:24:05 +01:00
Henrik
e0677bc570
Update source/contributing/documentation.md
...
Co-authored-by: Alexander Groleau <alex@proof.construction>
2023-07-17 16:23:53 +01:00
i97henka
23c5bade2a
adding how to help on pills.
2023-07-17 16:16:26 +01:00
Henrik
b1756bd187
Update source/contributing/documentation.md
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-07-17 16:05:07 +01:00
Alexander Groleau
adcb1a0d99
Merge pull request #648 from gerbrent/patch-1
...
correct dd command, removing .zst from if=*.img.zst
2023-07-17 09:28:04 -05:00
Valentin Gagarin
d49aed6039
remove collection of software Nix has influenced ( #295 )
...
this is marketing material and should not be in the responsibility of
documentation maintainers to curate.
2023-07-17 15:19:13 +01:00
Brent Gervais
d93129b5ba
correct dd command, removing .zst from if=*.img.zst
...
the command to image the SD card included `if=nixos-sd-image-......img.zst` though the intention here is to write the non-compressed image to the SD, not the compressed zst image.
.img.zst > .img
As written this command would not function as intended.
2023-07-16 09:45:57 -06:00
i97henka
10b936f6d8
adding nix pills to external sources.
2023-07-16 12:55:17 +01:00
Valentin Gagarin
b4628cdd04
Remove "reproducible" from glossary ( #646 )
...
* Remove "reproducible" from glossary
It is not part of the official terminology the nixos documentation team established in https://github.com/NixOS/nix.dev/pull/263 .
It was mixed in https://github.com/NixOS/nix.dev/pull/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 (https://github.com/NixOS/nix.dev/issues/464 ).
---------
Co-authored-by: davidak <davidak@users.noreply.github.com>
2023-07-13 21:33:29 +02:00
Valentin Gagarin
1fce49476d
Merge pull request #609 from NixOS/language-tutorial-title
...
Nix language tutorial: restructure introduction
2023-07-13 21:26:57 +02:00
Valentin Gagarin
16ffcd0651
move estimated effort after the prerequisites
2023-07-13 21:23:23 +02:00
Valentin Gagarin
db1d3c8404
revert change of title
...
introducing a negatively connotated word is probably not a good idea.
there is some risk of inducing fear that was not there before, and the
tongue-in-cheek aspect may not come across.
the title should be unique and easy to recognise, and it was. "Reading
the Nix language" is already the title of the talk most of this is based
on, and we shouldn't reuse it
2023-07-13 21:23:23 +02:00
Valentin Gagarin
57741ca766
fix custom admonition
2023-07-13 21:23:23 +02:00
Valentin Gagarin
561ee13ffa
don't use mobile wikipedia
2023-07-13 21:23:23 +02:00
Valentin Gagarin
fc308c367e
clarify details on name assignment
...
this fills a long-standing gap of not mentioning function arguments as
another form of name assignment
2023-07-13 21:23:23 +02:00
Valentin Gagarin
633a35514c
shorten introduction
...
the allusion to the Elements of Programming[0] never really worked out
[0]: https://mitp-content-server.mit.edu/books/content/sectbyfn/books_pres_0/6515/sicp.zip/full-text/book/book-Z-H-10.html#%_sec_1.1
2023-07-13 21:23:23 +02:00
Valentin Gagarin
8f4f1936c0
rename the Nix language tutorial
...
this collapses the "don't panic" section into a motivating introduction and gives
the document a more distinctive name.
this also addresses feedback stating that having "basics" in the title
may be misleading about the effort required to work through the
tutorial.
2023-07-13 21:23:23 +02:00
Zach Mitchell, PhD
09a38eeb3f
Merge branch 'master' into skeleton-workflow
2023-07-13 06:58:37 -06:00
Zach Mitchell
2592019afc
Fix more broken links
2023-07-13 06:57:31 -06:00
Zach Mitchell
614e04fe81
Fix broken link
2023-07-13 06:57:31 -06:00
Zach Mitchell
a3d9c019b1
Merge writing-style and style-guide
2023-07-13 06:57:31 -06:00
Zach Mitchell
00348edd0c
Add style guide
2023-07-13 06:57:31 -06:00
Zach Mitchell
9a6309c492
Add learning journey contribution guidelines
2023-07-13 06:57:31 -06:00
alex
2b1a05bcc3
fix boot config, correctly enable wlan firmware, update config link
2023-07-11 16:26:53 -05:00
proofconstruction
97112eb558
Update Raspberry Pi Installing NixOS Tutorial ( #641 )
2023-07-10 23:09:59 +02:00
alex
45c9382551
fix broken bob build link
2023-07-09 13:48:05 -05:00
Yuki Langley
ca0dc99eb6
Ignore linkcheck on GitHub file viewer/browser
...
This is done in order to unbreak CI until a proper solution is found.
Related to https://github.com/NixOS/nix.dev/issues/631
2023-07-07 17:47:55 +07:00
asymmetric
a119476444
Change project's self-description ( #575 )
...
nix.dev is now official
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-07-04 19:11:43 +02:00
alex
f8b9cae27b
fix reference link
2023-06-27 12:36:54 -05:00
alex
26e61307ad
reword parts of direnv section
2023-06-27 11:53:58 -05:00
alex
0ee2bc6371
add motivation & clarification to environment customization section
2023-06-27 11:47:20 -05:00
alex
9448dd1d0e
reword some parts of the getting started section. some bikeshedding
2023-06-27 11:42:49 -05:00
alex
c899dd4b5c
actually explain why declarative environments are useful
2023-06-27 11:39:05 -05:00
alex
1476d08634
add more contextual info to introduction
2023-06-27 11:37:16 -05:00
worktheclock
81617d94cd
Declarative reproducible developer environments
...
RITZA language edit.
2023-06-27 11:13:40 -05:00
Aaron Bennett
6d7bee54c5
Fix typo ( #619 )
...
Remove trailing backtick.
2023-06-27 00:12:38 +02:00
Valentin Gagarin
09cf170b0a
fix wording
2023-06-26 17:26:31 +02:00
Valentin Gagarin
33820f5751
why are flakes controversial ( #546 )
...
* concept: why are flakes controversial
2023-06-26 17:07:31 +02:00
Valentin Gagarin
1eed36a44b
add redirects for changed directory structure ( #608 )
2023-06-25 17:33:19 +02:00
Yuki Langley
145158825d
Generate 404.html ( #617 )
2023-06-25 17:23:09 +02:00
Yuki Langley
9aaa97a8b0
Make home page cards clickable ( #616 )
2023-06-25 14:13:20 +02:00
Yuki Langley
d426269f96
conf.py: Update repository url and branch ( #613 )
2023-06-24 14:54:09 +02:00
Valentin Gagarin
2ae6b07a97
move more writing style recommendations into the public guide ( #607 )
2023-06-22 11:18:22 +02:00
Valentin Gagarin
9c3e6c54fe
Merge pull request #597 from henrik-ch/nix-direnv
...
rebase of fzakaria pull request 83
2023-06-20 11:01:07 +02:00
i97henka
813a8ee490
making nix-direnv the default approach
2023-06-19 18:58:10 +01:00
alex
0c933bd9e8
Move writing style to separate page
2023-06-19 11:25:29 -05:00
i97henka
0773b5dc71
rebase of fzakaria pull 83
2023-06-18 10:43:38 +01:00
Valentin Gagarin
dcdb26075d
fix wording
...
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-06-15 04:55:11 +02:00
Valentin Gagarin
983ab67907
use "name" instead of "variable" consistently ( #588 )
...
strictly speaking, the Nix language does not have variables because what we call "variables" in the mathematical sense are names assigned to values that do not change, but can rather have different possible but fixed values depending on context.
this change is mainly to make use of words consistent with the Nix language tutorial in order to avoid any ambiguity and confusion for beginners, who may wonder why one article says "there are no variables" and the other one liberally uses the term regardless. always using "name" makes unmistakably clear that it's a variable in the mathematical sense.
2023-06-13 21:45:42 +02:00
asymmetric
a094ffe818
css: fix code box colors ( #595 )
2023-06-12 00:08:41 +02:00
Valentin Gagarin
181fdc6ced
refer to Nix manual for identifier syntax ( #542 )
...
that information should not be maintained here
2023-06-08 02:19:23 +02:00
Valentin Gagarin
0ca05fd6dc
glossary: add links to manuals and source code ( #550 )
2023-06-08 02:18:51 +02:00
Yuki Langley
c4c366160e
Add Nix snowflake logo ( #585 )
...
* Add Nix snowflake logo to sidebar
* Add Nix snowflake favicon
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-06-07 10:41:40 +02:00
Yuki Langley
793206a5e6
Fix invalid sitemap ( #586 )
2023-06-06 10:15:53 +02:00
Yuki Langley
32a1c63ad9
Improve landing page ( #584 )
...
Add overview of categories, and the origin of the name Nix
2023-06-05 17:31:49 +02:00
Yuki Langley
6f9bad97b1
Add robots.txt ( #583 )
2023-06-05 03:02:31 +02:00
asymmetric
a1d1ce5a98
Merge pull request #562 from NixOS/no-sponsors
...
Remove mention of corporate sponsors
2023-06-01 11:44:25 +02:00
asymmetric
ba16b1f4fc
Update source/acknowledgments/sponsors.md
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-06-01 09:42:01 +00:00
Valentin Gagarin
022188349d
concept: what are flakes ( #545 )
...
* concept: what are flakes
2023-06-01 10:59:29 +02:00
asymmetric
bfd57a67bb
Merge pull request #576 from NixOS/bump-deps
...
Bump Sphinx and theme
2023-06-01 10:53:05 +02:00
Valentin Gagarin
0bd24f7408
update contribution guide concerning the wiki
2023-05-31 02:18:55 +02:00
Valentin Gagarin
53a71b0666
same statement for both laziness notes
2023-05-30 15:11:20 +02:00
Valentin Gagarin
8009e92f82
do not leave pointers to the WHNF rabbit hole
...
these details are for the reference manual
2023-05-30 15:11:20 +02:00
Robert Hensing
1106e43cc1
nix-language: Don't imply strict eval is a thing (nix-instantiate)
2023-05-30 15:11:20 +02:00
Robert Hensing
6518e7cd6b
nix-language: Don't imply strict eval is a thing
2023-05-30 15:11:20 +02:00
Lorenzo Manacorda
0d860e87c5
sponsors: Add link to OpenCollective
2023-05-30 13:24:33 +02:00
Lorenzo Manacorda
65f7ca6387
sponsors: Add context before sponsors
2023-05-30 13:24:33 +02:00
Lorenzo Manacorda
687c1037d2
Fix config error
...
Newer Sphinx doesn't accept None, so leaving default of 'en'.
2023-05-29 11:58:25 +02:00
Lorenzo Manacorda
52b6f2d22e
Fix cachix link
2023-05-29 10:05:17 +02:00
Lorenzo Manacorda
49249e53a4
Remove sponsors from sidebar
2023-05-29 10:03:59 +02:00
Raphael Das Gupta
41ab7e1ee0
write "GitHub" with a uppercase "H" ( #574 )
2023-05-29 07:31:14 +01:00
Lorenzo Manacorda
d65308e6bd
Remove sponsors from footer
2023-05-28 19:44:52 +02:00
Valentin Gagarin
a8d640e6c6
Merge pull request #548 from fricklerhandwerk/language-pitfalls
...
turn anti-patterns into best practices
2023-05-25 16:52:10 +02:00
Lorenzo Manacorda
226cbfcfd5
link sponsors in footer
2023-05-25 13:03:23 +02:00
Lorenzo Manacorda
789897562d
add sponsors page
2023-05-25 13:02:47 +02:00
Lorenzo Manacorda
544a3de332
Sponsors -> Acknowledgments
2023-05-25 13:02:22 +02:00
Lorenzo Manacorda
d993a7f59c
Revert "Remove mention of corporate sponsors"
...
This reverts commit bbad27ea9fa8aba79151704bd73438d78eba4ea5.
We're going to mention past sponsors.
2023-05-25 13:02:22 +02:00
Lorenzo Manacorda
9a16562f0a
Remove mention of corporate sponsors
...
Now that the site is owned by the foundation.
2023-05-25 13:02:22 +02:00
nikstur
19f59af2d8
contributing: fix link ( #568 )
2023-05-19 09:41:51 +02:00
Valentin Gagarin
dd3deb5008
Update source/recipes/faq.md
2023-05-16 01:33:10 +02:00
Valentin Gagarin
3c857b4589
improve wording in contribution guide ( #549 )
...
* improve wording in contribution guide
2023-05-16 00:41:00 +02:00
eunsukimme
27cdc89c18
docs: edit tutorial command line at Nested shell sessions on Ad hoc shell environment page
2023-05-14 18:55:57 +09:00
Valentin Gagarin
7f3c6e1596
Merge pull request #551 from fricklerhandwerk/keywords
2023-05-14 10:39:27 +02:00
Domen Kožar
9f13d653fb
Merge pull request #262 from fricklerhandwerk/cla
...
assign copyright to NixOS Foundation
2023-05-12 13:04:00 +01:00
Valentin Gagarin
43b2887c3e
reword introduction to first steps tutorials
...
this more closely matches the current contents
2023-05-12 07:38:06 +02:00
Valentin Gagarin
034b6485c6
update keywords and language
...
most importantly Nixpkgs was missing.
the documentation team decided to use European English some time ago.
2023-05-12 07:25:46 +02:00
Valentin Gagarin
e47b082d22
turn anti-patterns into best practices
...
make generous use of admonitions
2023-05-12 05:49:48 +02:00
Valentin Gagarin
c6cbc22211
FAQ: should I enable flakes
2023-05-12 04:07:58 +02:00
Valentin Gagarin
744eeafbda
assign copyright to NixOS Foundation
...
based on Nix documentation team discussion on 2022-07-07
https://discourse.nixos.org/t/2022-07-07-documentation-team-meeting-notes-4/20198
"the author" are now nix.dev contributors, as this is the most accurate
way we can currently represent it. eventually we should provide a way to
credit authorship more precisely.
2023-05-11 20:48:39 +02:00
Valentin Gagarin
ac5b6c2a41
clarify notes on reading files
...
placeholders were referred to before showing the example, this is probably confusing
2023-05-11 18:49:29 +02:00
Valentin Gagarin
2bc7e57227
reword note on default.nix
2023-05-11 18:40:27 +02:00
Valentin Gagarin
964b3cf2e1
update Nix version in tutorial
...
this is the one currently in nixpkgs-unstable
2023-05-11 18:39:50 +02:00
Zach Mitchell
4ed3b9ceb8
Remove nesting, add tutorial series description
2023-05-09 22:36:30 -06:00
Zach Mitchell
b573def109
Set the structure of the tutorials section
2023-05-07 09:08:04 -06:00
Zach Mitchell
f127d9da6b
Add link to linkcheck ignore list
2023-05-06 12:56:18 -06:00
Zach Mitchell
8313ca8824
Fix link to renamed anchor
2023-05-06 12:39:39 -06:00
Lorenzo Manacorda
8834f94a67
integrate feedback and fix some issues
2023-04-29 21:50:42 +02:00
asymmetric
d9e8b3bbfe
Update source/contributing/how-to-get-help.md
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-04-29 19:43:30 +00:00
Lorenzo Manacorda
822aa7e49b
re-add to TOC
2023-04-17 12:12:45 +02:00
Lorenzo Manacorda
7e1880195f
incorporate feedback
2023-04-17 12:10:59 +02:00
asymmetric
40a1354419
Update source/contributing/how-to-get-help.md
...
Co-authored-by: Silvan Mosberger <github@infinisil.com>
2023-04-17 12:10:59 +02:00
Lorenzo Manacorda
b517356b57
add section on how to get help
2023-04-17 12:10:57 +02:00
Zach Mitchell, PhD
f61492b03f
Update reference list order
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-04-14 20:37:16 -04:00
Zach Mitchell
20f2673d70
Add recipes, reference, and contributing sections
2023-04-13 21:50:10 -04:00
LX
fc1cad935a
add details about import
( #506 )
...
Add information about the behaviour of `import` if the given path is a directory.
Co-authored-by: Silvan Mosberger <github@infinisil.com>
2023-04-06 23:44:42 +02:00
Zach Mitchell, PhD
00e8606dd7
Fix typos in ad-hoc-developer-environments.md
2023-04-05 22:08:09 -04:00
Valentin Gagarin
89d5f8aa37
Merge pull request #491 from Hamled/patch-1
...
NIX_PATH includes nixpkgs in cross-compilation.md
2023-04-05 01:26:26 +02:00
Valentin Gagarin
e5738519fc
Merge pull request #449 from fricklerhandwerk/pinning-fixups
...
fixups to pinning overview
2023-04-04 10:35:44 +02:00
Valentin Gagarin
d433507a62
clarify local expression path
2023-04-04 10:29:59 +02:00
Niklas Mohrin
ac72c7256b
Add missing trailing newline in multi-line string example
2023-03-30 22:35:40 +02:00
Valentin Gagarin
07de7ee501
remove redundant terms from glossary
...
we should always link to authoritative definitions of terms when they
exist, instead of doing double book keeping here.
"attribute name" should be uniquely defined in the Nix reference manual.
"package name" should be uniquely defined in the Nixpkgs manual.
2023-03-30 09:58:16 +02:00
Yuki Langley
25247077f4
Merge branch 'master' into information-overload
2023-03-29 14:20:53 +07:00
Charles Ellis
2067612bb3
NIX_PATH includes nixpkgs in cross-compilation.md
2023-03-23 17:47:45 -07:00
wzy
2da2d37082
Add information about installing nix by pacman ( #399 )
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-03-21 11:24:30 +01:00
Valentin Gagarin
77b5531a9a
rework nix-shell tutorial ( #447 )
...
this addresses multiple issues observed in user studies, in order to
make the first steps as smooth as possible.
2023-03-20 21:01:08 +01:00
Valentin Gagarin
be5a4c180a
Merge pull request #472 from NixOS/shebang
...
reword introduction to shebangs
2023-03-17 02:25:36 +01:00
Valentin Gagarin
959af485f9
make section title unambiguous
...
otherwise it may sound like we're talking about how-to guides here
2023-03-17 01:55:51 +01:00
Valentin Gagarin
076328e189
reword introduction to shebangs
...
a shebang is not the line, just the character sequence.
also it doesn't matter that much, so we may as well be brief.
2023-03-17 01:14:03 +01:00
Valentin Gagarin
2db9980664
fix heading level
2023-03-17 01:09:44 +01:00
Valentin Gagarin
1209c11eb0
fix wording
2023-03-17 01:07:35 +01:00
Valentin Gagarin
68ca23955d
ignore lesswrong.com on linkcheck
...
their server returns 403 on CI runs even for valid URLs
2023-03-17 00:59:46 +01:00
Valentin Gagarin
22c0bf8523
add a guide on writing tutorials
...
including references to valuable resources, the authors of which know
much better what they're doing.
2023-03-17 00:59:43 +01:00
olaf
442577eb25
tutorial: nixos configurations on vm ( #334 )
...
* tutorial: nixos configurations on vm
Co-authored-by: Benoit de Chezelles <bew@users.noreply.github.com>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Henrik <i97henka@gmail.com>
2023-03-16 18:37:04 +01:00
Valentin Gagarin
18bae0f41c
Merge pull request #446 from fricklerhandwerk/interpreted-scripts-next-steps
...
add additional links and next steps
2023-03-13 09:57:55 +01:00
Valentin Gagarin
a9f1378349
use OpenGroup's spec for env
2023-03-08 22:19:46 +01:00
Valentin Gagarin
c21145daa3
fix wording
2023-03-06 23:04:51 +01:00
Valentin Gagarin
0a5fa83a28
introduce the documentation team
...
since many people arrive here without prior knowledge,
there is no way for them to associate this resource with the official team.
2023-03-06 23:04:01 +01:00
Panashe Fundira
f16fd5854c
Quote URLs in nix language tutorial
...
Called out as an anti-pattern https://nix.dev/anti-patterns/language#unquoted-urls
This change is to make the docs more self-consistent, and promote good habits in the reader.
2023-03-05 08:51:35 -05:00
Valentin Gagarin
35833bd9fe
limit depth of tutorials TOC
2023-03-05 02:53:27 +01:00
Domen Kožar
36d3bf7bd7
bump actions to fix a critical bug
2023-03-01 06:03:02 +00:00
Pol Dellaiera
2de1f5bd12
Update nix-language.md ( #453 )
2023-02-25 00:49:34 +01:00
Valentin Gagarin
724cc43ae1
fix broken link
2023-02-20 15:33:29 +01:00
Henrik Karlsson
cc76b7d0cb
removing snabb hydra cache
...
This hydra cache no longer exists.
2023-02-20 08:40:55 +00:00
Henrik
fda85e22d0
working on #PR 325 - nix shell and shellbang ( #427 )
...
* changing to non-mobile wiki link
* adding link to nix-shell pure option.
* mentioning shebang just under the heading.
* adding bash in the listed included packages.
* corrected link snippet
* address review comments
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-02-16 19:23:23 +01:00
Valentin Gagarin
710a10af81
fixups to the Nix language manual ( #448 )
2023-02-16 15:48:22 +01:00
Valentin Gagarin
05d79a4203
fixups to pinning overview
...
remove the NixOS example, as the sample has lots of caveats, such as
having to rebuild NixOS a second time to make it effective.
2023-02-16 06:23:33 +01:00
Valentin Gagarin
a6efa591dc
add additional links and next steps
2023-02-16 02:36:45 +01:00
Solène Rapenne
91eda534ef
add tutorial for nix-shell in shebang ( #325 )
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-02-14 18:24:11 +01:00
Maksim Horbul
0db5c1e909
fix: type in the code example
2023-02-12 09:50:47 +01:00
Valentin Gagarin
9241b4f1d6
do not duplicate information on references
2023-02-09 19:47:25 +01:00
Valentin Gagarin
afe81027aa
refine wording around string interpolation
2023-02-09 19:47:25 +01:00
Gabriella Gonzalez
51d2fa4e9c
Add credit for integration test example ( #434 )
2023-02-08 01:22:50 +01:00
Valentin Gagarin
069bb6ffb4
bring back IPA pronunciation ( #431 )
2023-02-07 16:46:29 +01:00
Valentin Gagarin
c22b9e139f
remove notes and links to verifying Nix installation
...
Nix releases aren not signed any more:
https://github.com/NixOS/nix/pull/7411
nixos.org does not have the referenced section any more:
https://github.com/NixOS/nixos-homepage/pull/975
2023-02-06 10:30:48 +01:00
Felix Uhl
e57b033647
Rename antiquotation to string interpolation
...
This is in accordance with the official naming, which was
[changed in Release 2.13](https://nixos.org/manual/nix/stable/release-notes/rl-2.13.html ).
2023-01-30 15:27:17 +01:00
Domen Kožar
ea42f78c36
Merge pull request #422 from doubledup/patch-1
...
Make install command in documentation compatible with fish shell
2023-01-24 16:40:41 +00:00
Ottmar Deinhart
d8b911d12f
show how to exit nix repl ( #433 )
2023-01-20 22:21:53 +01:00
Jeremy Kolb
76ef73f079
Clarify that name should be set in builtins.path ( #430 )
...
* Clarify that name should be set in builtins.path
2023-01-18 19:07:43 +01:00