Commit Graph

570 Commits

Author SHA1 Message Date
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
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