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

510 commits

Author SHA1 Message Date
alex a4233f2d8b use latest release instead of master 2023-08-10 10:42:45 -05:00
alex c70df9511c move dependencies to derivation inputs, because we use callPackage 2023-08-10 10:42:45 -05:00
alex 0797d1cd4e remove namespace errors 2023-08-10 10:42:45 -05:00
alex a1eea0bf77 the stdenv is doing the work, not nix itself 2023-08-10 10:42:45 -05:00
alex e88e060e67 let the manual more-verbosely explain fetchFromGitHub arguments 2023-08-10 10:42:45 -05:00
alex f1d6bf20bd note what callPackage does 2023-08-10 10:42:45 -05:00
alex bbb4a130b6 use lib.fakeSha256 instead of a string of 53 zeroes 2023-08-10 10:42:45 -05:00
alex 77daebd127 rephrase fetchTarball introduction 2023-08-10 10:42:45 -05:00
alex ce6bd9a913 add explanation of what "package" means here 2023-08-10 10:42:45 -05:00
alex 0a211946de remove contributing to nixpkgs section 2023-08-10 10:42:45 -05:00
alex 0c2c29e27d mention that the stdenv automates a lot of this 2023-08-10 10:42:45 -05:00
alex 62ea6335c3 add draft of packaging existing software tutorial 2023-08-10 10:42:45 -05:00
Zach Mitchell, PhD 31f269d2d9
Merge pull request #671 from zmitchell/shell-tutorial
Add shell.nix tutorial
2023-08-10 09:23:52 -06:00
Zach Mitchell 56429a2b66 Update with docs team review 2023-08-10 09:20:30 -06:00
Zach Mitchell a0a4cd8968 Update with review comments 2023-08-09 22:06:21 -06:00
Alexander Groleau 58464f3967 fix broken anchor 2023-08-07 10:29:05 -05:00
Zach Mitchell 5b29e71e43 Add shell.nix tutorial 2023-08-02 21:57:38 -06:00
Jeremy fd9c34b940
Clarify and fix grammar/spelling mistakes in the installation guide for the Pi (#667) 2023-08-01 20:49:32 +02:00
Zach Mitchell, PhD 808ac3b3ce Update source/tutorials/reproducible-scripts.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-07-27 08:59:32 -06:00
Zach Mitchell, PhD 64348ea907 Update source/tutorials/reproducible-scripts.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-07-27 08:59:32 -06:00
Alper Cugun 56ba5bda03 Explain what this construct is
> The chained script interpreter to be invoked

Chained is mentioned here but then also forgotten about: https://nixos.org/manual/nix/unstable/command-ref/nix-shell.html

Mostly it's unclear here why there are multiple weird hashbang lines there that are the same.

Also it's not great that here an entirely new construct is introduced that probably nobody will have ever seen before and to understand what it does you have to go to several different off-site documentation pages.

Can this be rewritten to be more standalone?
2023-07-27 08:59:32 -06:00
Silvan Mosberger 395ae61d71
Merge pull request #659 from henrik-ch/fix-non-NixOS
small touch-up - removing non-NixOS referral
2023-07-27 16:06:51 +02:00
Tanner Wilcox 678d749e04
Update ad-hoc-shell-environments.md (#661)
Typo fix
2023-07-24 08:35:46 +01:00
Henrik 27ec931631
Update installing-nixos-on-a-raspberry-pi.md
removing non-NixOS reference
2023-07-21 19:30:39 +01:00
Jaime Terreu fd3494bee8
Fix small typo (#658)
Co-authored-by: Jaime Terreu <jaime@Jaimes-MacBook-Pro.local>
2023-07-21 16:25:00 +02:00
i97henka a0c388342e adding note about using etcher when on non-nixos system. 2023-07-20 18:21:23 +01:00
Carlos Marques f281829318
fix mismatching file name in example (#655) 2023-07-20 17:59:43 +02:00
John Bowdre 21abf7b6ad
Fix typo in ad-hoc-shell-environments.md (#652)
Footnote 2: 'packges' -> 'packages'
2023-07-19 16:25:07 +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
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 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 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
Valentin Gagarin 1eed36a44b
add redirects for changed directory structure (#608) 2023-06-25 17:33:19 +02:00
Yuki Langley 9aaa97a8b0
Make home page cards clickable (#616) 2023-06-25 14:13:20 +02:00
i97henka 813a8ee490 making nix-direnv the default approach 2023-06-19 18:58:10 +01:00
i97henka 0773b5dc71 rebase of fzakaria pull 83 2023-06-18 10:43:38 +01: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
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
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
Raphael Das Gupta 41ab7e1ee0
write "GitHub" with a uppercase "H" (#574) 2023-05-29 07:31:14 +01: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 43b2887c3e reword introduction to first steps tutorials
this more closely matches the current contents
2023-05-12 07:38:06 +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 8313ca8824 Fix link to renamed anchor 2023-05-06 12:39:39 -06: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
Niklas Mohrin ac72c7256b
Add missing trailing newline in multi-line string example 2023-03-30 22:35:40 +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 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
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
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
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 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 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
luukasahola 5a0d95fcd2 Fixed a minor function spelling error (Definitely didn't fix this to claim to be a NixOS contributor) 2023-01-10 12:25:19 +02:00
Luc Perkins af9c9eb3c1
Merge pull request #405 from yukiisbored/styling
Improve readibility via styling improvements
2023-01-05 16:43:55 +00:00
David Dunn be05bdef94
Use a pipe for all install commands 2022-12-28 09:36:27 +04:00