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

652 commits

Author SHA1 Message Date
Valentin Gagarin cc7d705cf3 clean up references 2023-10-23 02:12:41 +02:00
fricklerhandwerk 0d93318c5c move python dev env sample to recipes
Co-authored-by: Alexander Groleau <alex@proof.construction>
2023-10-09 21:23:26 +02:00
alex d003321adb move direnv instructions to recipes, update and rework text
Co-authored-by: fricklerhandwerk <valentin@fricklerhandwerk.de>
2023-10-09 13:37:21 -05:00
Alexander Groleau 14b2fc7848
Merge pull request #756 from fricklerhandwerk/merge-shell-tutorials
merge the two shell.nix tutorials into one
2023-10-09 13:17:12 -05:00
fricklerhandwerk ea104900d0 merge the two shell.nix tutorials into one
rephrase slightly for brevity and clarity.

re-use the examples from the ad-hoc environment tutorial both for
simplicity as well as to give it some continuity.

Co-authored-by: Alexander Groleau <alex@proof.construction>
2023-10-09 20:13:19 +02:00
Alexander Groleau 325915aa41
Merge pull request #752 from fricklerhandwerk/merge-pinning-docs
add introduction to cross compilation tutorial
2023-10-09 08:50:09 -07:00
fricklerhandwerk 9961ac5d54 add introduction to cross compilation tutorial
remove references to "towards reproducibility" as that's not very
focused, and at that point readers will likely be familiar with the
concept such that they only need the reference, if anything
2023-10-09 17:46:24 +02:00
fricklerhandwerk 869d6bd0b4 move Nix language tutorial to top level
this fits the global outline we developed, and also makes the tutorial
more immediately visible - working with the Nix language is a core skill
we want to teach after all
2023-10-09 17:26:06 +02:00
Alexander Groleau 6cd0c3de72
Merge pull request #748 from fricklerhandwerk/add-links
clean up detailed explanation on building VMs
2023-10-09 08:08:14 -07:00
Alexander Groleau 84bbc7c230
Merge pull request #725 from olafklingt/server-client-test
simple server client test
2023-10-09 08:07:37 -07:00
asymmetric eaded9b070
Merge pull request #746 from fricklerhandwerk/move-warning
highlight password security warning in NixOS example
2023-10-09 11:27:57 +02:00
fricklerhandwerk 769cff9030 clarify detailed explanation 2023-10-07 04:21:19 +02:00
fricklerhandwerk a2a706f29d don't repeat the example contents in the instruction 2023-10-07 04:12:44 +02:00
fricklerhandwerk cd1abe532b use self-descriptive link text, imperative for instructions 2023-10-07 04:12:44 +02:00
fricklerhandwerk a1b582f33a modules are not a convention 2023-10-07 04:12:44 +02:00
fricklerhandwerk 82e7185436 remove superfluos capitalisation 2023-10-07 04:12:44 +02:00
fricklerhandwerk 4bcf52fe1b reword learning goal to use more keywords 2023-10-07 04:12:43 +02:00
fricklerhandwerk d59250908d remove compatibility blurb
readers don't even need to think about it, as it's encoded in the pinned
source. at best this would be a note to maintainers, but we should know
that as well.
2023-10-07 04:11:46 +02:00
fricklerhandwerk 776d19f8e8 dedent list 2023-10-07 04:11:44 +02:00
fricklerhandwerk d876a318bc more concise instructions 2023-10-07 00:37:42 +02:00
fricklerhandwerk 4b814d5d37 more precise heading 2023-10-07 00:37:27 +02:00
fricklerhandwerk e6ae1afaed highlight password security warning in NixOS example 2023-10-06 23:23:50 +02:00
Valentin Gagarin a279bfbd6a
avoid gerund 2023-10-06 23:21:20 +02:00
Valentin Gagarin 35ae4de7ca
more mundane grammar 2023-10-06 23:20:19 +02:00
fricklerhandwerk 07ea1eb6b2 rework the multi-machine example
- use the same Nixpkgs release to avoid massive downloads
- continue using `pkgs.nixosTest`; the new thing is completely undocumented
- use a shorthand module; `lib` is not used
- use an empty nginx config; commented-out code is confusing
- move explanation of the test script to the end; use imperative
- add instructions to run it
2023-10-06 22:51:08 +02:00
fricklerhandwerk e5f8ca0a9d reword introduction to multi-machine example 2023-10-06 22:51:07 +02:00
fricklerhandwerk 2a8bc7dd63 more concise heading 2023-10-06 22:50:46 +02:00
fricklerhandwerk 256bcd47ea remove superfluos empty line 2023-10-06 22:50:46 +02:00
fricklerhandwerk f15b5a4df3 build up example as numbered list
while section headings are good for linking, this is not very important
here. the heading distract from the sequential structure, which the list
exposes more clearly.
2023-10-06 22:50:46 +02:00
fricklerhandwerk 5fd6576a8d fix wording 2023-10-06 22:50:46 +02:00
fricklerhandwerk 0e63b762b9 clarify wording around module options 2023-10-06 22:50:46 +02:00
fricklerhandwerk 0067b57ebc remove superfluos indentation 2023-10-06 22:50:46 +02:00
fricklerhandwerk 14adbcfb87 use self-descriptive link text 2023-10-06 22:50:46 +02:00
fricklerhandwerk c7dfcb7968 link to main Nix installation instructions 2023-10-06 22:50:46 +02:00
fricklerhandwerk 1ad3a3e2f8 more specific title 2023-10-06 22:50:46 +02:00
olaf 13ca4846b2 fix wording 2023-10-06 22:50:46 +02:00
olaf 56426054ed unrelated fixes 2023-10-06 22:50:46 +02:00
olaf 4509761055 simple server client test 2023-10-06 22:50:45 +02:00
Valentin Gagarin 8ef096641d
Merge pull request #741 from fricklerhandwerk/move-installation
move installation instructions to top level
2023-10-06 13:36:34 +02:00
Valentin Gagarin a8723671ee
Merge pull request #745 from NixOS/editorconfig
Add EditorConfig file and fix errors
2023-10-06 12:09:23 +02:00
Valentin Gagarin d7556d18b1
Merge pull request #728 from g-re-g/patch-1
change "build task" to "derivation" in tutorial

"build task" invokes associations with pre-existing knowledge. As long as they are clearly explained, it is easier for beginners to pick up a new word than it is to add a new definition to an existing word that subtly differs from the other definitions it has. To that extent, "derivation" is probably a great word for Nix as, at least in this domain, it is very Nix specific and so, with clear definition, it should be easy to convey the idea to other folks that we are talking about something Nix specific.
2023-10-06 12:02:22 +02:00
Lorenzo Manacorda 1dcc111a4d *: fix editorconfig errors 2023-10-06 10:59:27 +02:00
fricklerhandwerk c0ef0b5988 move installation instructions to top level
it's not a tutorial and should be immediately accessible
2023-10-06 09:46:54 +02:00
a c sreedhar reddy f2fe0aa56b
Remove write space in shebang line (#736) 2023-10-03 10:12:05 +02:00
Yann Hamdaoui 62db5ba51d
Remove superfluous variation of a snippet (#732)
The cross compilation documentation is showing, at some point, two
variations on how to get a cross-compiled package out of Nixpkgs. Those
two versions are strictly equivalent (the only difference is what part
of the full attribute set paths is put in the variable named `pkgs`) and
don't really improve understanding - arguably, rather hurts it.
2023-09-20 21:51:32 +02:00
g-re-g f381e24357
Better terminology for string interpolation of derivations
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-09-14 13:00:00 -04:00
g-re-g 11f943e3b3
Remove description of derivation using "build task"
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-09-14 12:59:25 -04:00
Valentin Gagarin 68839d3d60
Merge pull request #621 from CyberShadow/patch-1
tutorials/first-steps/nix-language: Fix the nixpkgs example
2023-09-14 15:24:30 +02:00
g-re-g f60d8a8671
change "build task" to "derivation" in tutorial 2023-09-13 14:15:26 -04:00
Valentin Gagarin 2bcb9da7c3
fix cross-link 2023-09-11 15:19:24 +02:00
Valentin Gagarin 668d318fe3
add technical detail
hopefully not too much
2023-09-11 15:17:16 +02:00
Valentin Gagarin 2955e01632
update note on macOS 2023-09-11 15:15:14 +02:00
Valentin Gagarin 2dfe03711d
add keyword 2023-09-11 15:14:15 +02:00
Valentin Gagarin 7a681b98ef
wording and links 2023-09-11 15:13:00 +02:00
Valentin Gagarin bfb1858a51
formatting and consistency 2023-09-11 15:08:42 +02:00
olaf 2fed480cdd pkgs = import nixpkgs {config = {}; overlays = [];}; 2023-09-11 12:22:30 +02:00
olaf 73486dd8f1 simplify used parts of default configuration.nix
move Re-run successful tests into a detais section.
2023-09-11 11:49:20 +02:00
olaf 05a570cfd5 fix title of testing vm tutorial 2023-09-11 10:59:55 +02:00
olaf 44333f7fb4 fix references heading in vm tutorial 2023-09-11 10:59:13 +02:00
olaf 5ae9aba3a5 reorder tutorials in nixos index 2023-09-11 10:56:28 +02:00
olaf 6a2a3e49de functionality of nixpkgs 2023-09-10 22:54:59 +02:00
olaf 82b206d031 fix link warning 2023-09-10 22:44:16 +02:00
olaf 9461c93af1 first reactions to comments 2023-09-10 22:24:20 +02:00
olaf 1fe25c832f Apply suggestions from code review
Co-authored-by: Silvan Mosberger <github@infinisil.com>
2023-09-10 22:23:47 +02:00
olaf 97ba15ed48 comment ref to not merged tutorial 2023-09-10 22:23:41 +02:00
olaf 62145d03d5 Apply suggestions from @fricklerhandwerk
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-09-10 22:23:31 +02:00
olaf 691e4636d0 expand on nixos configuration testing
use of fricklerhandwerks review of integration test
2023-09-10 22:23:04 +02:00
Jonathan Arnett 9c7e4a8156
Use bold instead of monospace for emphasis 2023-09-02 23:17:53 -04:00
Zach Mitchell b038f6e117 Update sharing deps tutorial 2023-08-28 11:17:07 -06:00
Zach Mitchell, PhD bc863f7f85
Merge pull request #675 from zmitchell/sharing-deps-tutorial 2023-08-25 21:34:04 -06:00
Graham Christensen c703c92234
Apply review nits
Co-authored-by: Alexander Groleau <alex@proof.construction>
2023-08-25 20:31:20 -04:00
Graham Christensen 3fbc19b874
Add the Magic Nix Cache as an option to the GitHub Actions page
Not sure if this is the right place for it, but it seemed like the most direct place to add it.
I'm open to other suggestions as well.
2023-08-24 14:44:36 -04:00
Zach Mitchell 8c6a172b03 Explain the shell attribute 2023-08-23 22:12:05 -06:00
Zach Mitchell 4b97c6b88e Update with review comments 2023-08-23 22:08:28 -06:00
Zach Mitchell 19be694d6b Add sharing deps tutorial 2023-08-23 21:44:55 -06:00
Zach Mitchell b4651ec6d5 tweak shell.nix tutorial 2023-08-16 18:14:05 -06:00
Alexander Groleau 818d33c7df add instructions for enabling hardware graphics acceleration 2023-08-14 15:10:44 -05:00
Alexander Groleau 6bd4567302 recommend nix-locate/nix-index 2023-08-10 10:45:03 -05:00
Alexander Groleau 7c950a309e remove name error encounter 2023-08-10 10:45:03 -05:00
Alexander Groleau f1fb505398 Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau b9056f6d3a Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 8e38972d40 Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 06285c2e72 Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Silvan Mosberger <github@infinisil.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 582553cf3c Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 7a9199115f Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau c714c04a60 Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 2ab3c4b4ad Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 42cf37cd43 Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau b374799ca2 Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 2ace3c6e1c Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 37f5fd3030 Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 4ed39f5eff Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 8998be56e4 Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau a7af180486 Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 24fba428cb Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 7ede9c5115 Update source/tutorials/learning-journey/packaging-existing-software.md
Co-authored-by: Zach Mitchell, PhD <zmitchell@fastmail.com>
2023-08-10 10:45:03 -05:00
Alexander Groleau 1ccaedafd0 one sentence per line 2023-08-10 10:45:03 -05:00
Alexander Groleau 9ae846d325 remove unnecessary console output 2023-08-10 10:45:03 -05:00
Alexander Groleau a0d5460989 no longer using dev output of libX11 2023-08-10 10:45:03 -05:00
Alexander Groleau f8f420ddb5 remove pkgs from args 2023-08-10 10:45:03 -05:00