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

625 commits

Author SHA1 Message Date
Valentin Gagarin b29081d5c6
fix typography (#822) 2023-12-01 00:57:48 +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
Alexandre Macabies a15d8a3eda
Fix link anchor typo (#810) 2023-11-25 15:32:24 +00:00
Silvan Mosberger 614b6fe50f
File sets tutorial (#802)
* source file selection tutorial

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-11-23 17:14:46 +01:00
olaf 7941b348a0
vm change to reproducible command (#804)
* add paragraph on a reproducible nixos-generate-config

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-22 17:43:38 +01:00
Silvan Mosberger 37922482b7
Module system deep dive tutorial (#645)
* Draft module system introduction tutorial

* add intro/conclusion, rework prose, follow styleguide, clean diffs

* Review pass

* Apply suggestions from code review

* fix whitespace

* add some more motivation the each section

* make scripts downloadable

* address review comments

* make script actually work

...hopefully. can't test it without Google API key

* add file watching

yes, this looks scary, and yes, it works.

* update diff and wording

* more notes on potential pitfalls

* be explicit which `map` we mean

* split nullable from default values

* also wrap the geocode script

* work through the tutorial to the end

* add tutorial overview

* `lib` is always passed

* add separate section for `evalModules` and fix link

* make option strucutre more self-explanatory

* explain command line invocations

* add note on incomplete reference documentation

* add more highlight to the `config` distinction

* fix parameter passing to the `./map` script

* fix typo

* fix wording

* link to summer of nix

* add missing word

* link to Google Maps API docs

* more explicit requirement

* use correct module system terminology

* Update source/tutorials/module-system/module-system.md

* Apply suggestions from code review

* whitespace

* module-system.md: replace comments with captions

* add missing lang for code-block

* Update module system title

* change most headers to be about module features (#797)

* change most headers to be about module features

Some headers could not be made about module features, and that's a
strong signal that those sections should be removed.

* Apply suggestions from code review

* module-system.md: Fix header casing

Co-authored-by: Alexander Groleau <source@proof.construction>
Co-authored-by: asymmetric <lorenzo@mailbox.org>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-20 17:21:06 +01:00
Lorenzo Manacorda ca15343a1a Fix spell checking errors 2023-11-13 13:46:03 +01:00
Valentin Gagarin 5aa0254754
search path -> lookup path (#747)
recent additions to the Nix manual clarify the distinction between
search path and lookup path, and also document the resolution algorithm.

lookup paths are now a distinct Nix language construct with its own
reference documentation.
2023-11-13 10:30:42 +01:00
Addison Grant ea8357b149
Remove specific software name from header in docs (#795)
* Remove specific software name from header

There's enough detail about it below, and the specific tech isn't the point of this section anyway.

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-09 23:05:01 +01:00
Rob Thomas fcac94d552
updated the context for the installation script to match the example … (#793)
* updated the context for the installation script to match the example for steps outlined

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-09 18:39:00 +01:00
Valentin Gagarin 8a74a98c54
rewrite guide to pinning dependencies with niv (#782)
* rewrite guide to pinning dependencies with niv

* use the specific branch directly

Co-authored-by: Silvan Mosberger <github@infinisil.com>

* use the shell's niv explicitly

* Apply suggestions from code review

---------

Co-authored-by: Silvan Mosberger <github@infinisil.com>
2023-11-07 22:26:23 +01:00
Valentin Gagarin 1b3be81da7
fix stray link reference 2023-11-02 20:03:33 +01:00
Valentin Gagarin 5c0ac8a727
add best practice on reproducible Nixpkgs configuration (#780) 2023-11-02 02:30:40 +01:00
fricklerhandwerk 8afee98203 dissolve the Learning Journey section
This does not yet follow #701, because the change to get there would be
too big. The goal is to keep the table of contents meaningful at all
times and the diff of each pull request manageable.

The packaging tutorial is quite important, so it's not wrong to have it
visible on the front page until we have enough material for a packaging
section.

The sharing dependencies article should really be a very brief guide, but
because that would be quite a big change, it's only moved to the Guides
section for now.
2023-11-02 00:13:32 +01:00
fricklerhandwerk 2f09d22b8b fix styling issues and links 2023-11-01 23:52:10 +01:00
olaf 0c7bb8e86c
Update source/tutorials/nixos/installing-nixos-on-a-raspberry-pi.md
Co-authored-by: Yuki Langley <hi@yukiisbo.red>
2023-10-24 11:53:31 +02:00
olaf 1ecd4dfc0b
Update installing-nixos-on-a-raspberry-pi.md
fix link to raspberry pi bootloader_update_stable
2023-10-23 11:23:08 +02:00
Valentin Gagarin 833a73b7a3 add graphical environment as requirement
the instructions say that the command will open a window, which
naturally requires a graphical environment. but this is very late in the
process, and will likely not be obvious in the middle of a a self-directed learning situation.
2023-10-23 02:16:02 +02:00
Valentin Gagarin 2566dbbf0c reword to direct instructions 2023-10-23 02:15:50 +02:00
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