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

442 commits

Author SHA1 Message Date
Valentin Gagarin 92e6e2341e add dynamic typing 2022-10-04 08:34:31 +02:00
Valentin Gagarin 80b0dcb8ae expand on single function argument 2022-10-04 08:34:31 +02:00
Valentin Gagarin fa674e3e11 restructure introduction 2022-10-04 08:34:31 +02:00
Valentin Gagarin e5d41c8425 remove word repetition 2022-10-04 08:34:31 +02:00
Valentin Gagarin 3f3a2a432f add recommendaton to search paths 2022-10-04 08:34:31 +02:00
Valentin Gagarin cda602d3fb restructure examples 2022-10-04 08:34:31 +02:00
Valentin Gagarin 4d65ecf82c WIP: side effects 2022-10-04 08:34:31 +02:00
Valentin Gagarin 388e658437 break up long sentence 2022-10-04 08:34:31 +02:00
Valentin Gagarin 339320ffa1 restructure headings
this will have a nicer display in the table of contents
2022-10-04 08:34:31 +02:00
Valentin Gagarin 0c7c1eb594 everyone calls them side effects 2022-10-04 08:34:31 +02:00
Valentin Gagarin 76561aa33a add structure to config example 2022-10-04 08:34:31 +02:00
Valentin Gagarin f5439cdbc4 expand shell example 2022-10-04 08:34:31 +02:00
Valentin Gagarin 67b5187a30 clarify outline 2022-10-04 08:34:31 +02:00
Valentin Gagarin ca66ac9a6a guide -> direct 2022-10-04 08:34:31 +02:00
Valentin Gagarin 573586b684 prerequisites: programming languages -> software development 2022-10-04 08:34:31 +02:00
Valentin Gagarin 7f6404c1ae restructure intro to functions 2022-10-04 08:34:31 +02:00
Valentin Gagarin ceff1d7713 json example: set -> object 2022-10-04 08:34:31 +02:00
Valentin Gagarin 678d3ce737 restrucutre note on . and .. paths 2022-10-04 08:34:31 +02:00
Valentin Gagarin c510aeb295 show example passing an attrset 2022-10-04 08:34:31 +02:00
Valentin Gagarin f3e192e3b8 add note on ./. syntax 2022-10-04 08:34:31 +02:00
Valentin Gagarin 5a638c5ed8 fix grammar and typo 2022-10-04 08:34:31 +02:00
Valentin Gagarin f1c90cdda5 function call: argument -> operand 2022-10-04 08:34:31 +02:00
Valentin Gagarin f6ad05bf24 comment out missing links 2022-10-04 08:34:31 +02:00
Valentin Gagarin 4273dc987f tutorial -> guide 2022-10-04 08:34:31 +02:00
Valentin Gagarin c0ca352c83 remove trivial builders from libraries
they really belong to generic build mechanisms, and we will not cover
them here.
2022-10-04 08:34:31 +02:00
Valentin Gagarin d16b6fcf72 add section on libraries 2022-10-04 08:34:31 +02:00
Valentin Gagarin c7729502bc remove description of language properties
this should be in the Nix manual
2022-10-04 08:34:31 +02:00
Valentin Gagarin c0b0c2ba32 add link to Nix Pills 2022-10-04 08:34:31 +02:00
Valentin Gagarin 354f8cba72 add aka @ pattern 2022-10-04 08:34:31 +02:00
Valentin Gagarin cb14464be1 reword intro to inherit 2022-10-04 08:34:31 +02:00
Valentin Gagarin ef5f3823cc uniform format for code samples 2022-10-04 08:34:31 +02:00
Valentin Gagarin e4bfdf0707 add overview on what using Nix language entails
inspired by https://news.ycombinator.com/item?id=32364899
2022-10-04 08:34:30 +02:00
Valentin Gagarin 5bc7fa3ebb expand NixOS config example 2022-10-04 08:34:30 +02:00
Valentin Gagarin 0e529426f7 add todo to clarify string interpolation and bash variables 2022-10-04 08:34:30 +02:00
Valentin Gagarin efaf7a82b7 add aka antiquotation 2022-10-04 08:34:30 +02:00
Valentin Gagarin 792ffe8f16 add draft on side effects 2022-10-04 08:34:30 +02:00
Valentin Gagarin 807665e3ae fix rendering errors 2022-10-04 08:34:30 +02:00
Valentin Gagarin a26c1825ea clarify language properties 2022-10-04 08:34:30 +02:00
Valentin Gagarin 1862f364e6 add summary of learnings 2022-10-04 08:34:30 +02:00
Valentin Gagarin 8f93a41e0a add notation for assigning nested attributes 2022-10-04 08:34:30 +02:00
Valentin Gagarin a2c88a1d20 expand on accessing values 2022-10-04 08:34:30 +02:00
Valentin Gagarin 6621db635c use console highlighting where appropriate 2022-10-04 08:34:30 +02:00
Valentin Gagarin b5db48cd6f uniform example format 2022-10-04 08:34:30 +02:00
Valentin Gagarin 13ad04881c simpler let ... in alias 2022-10-04 08:34:30 +02:00
Valentin Gagarin 8dee6f4894 attrsets are unordered 2022-10-04 08:34:30 +02:00
Valentin Gagarin e48e524ff6 fixes and TODOs 2022-10-04 08:34:30 +02:00
Valentin Gagarin fc12f3606c reorder sections 2022-10-04 08:34:30 +02:00
Valentin Gagarin 6b807a91c5 add evaluation result to example 2022-10-04 08:34:30 +02:00
Valentin Gagarin 87df93e7f8 sharpen title to narrow scope 2022-10-04 08:34:30 +02:00
Valentin Gagarin 558ec3b67e clarify what expressions and values are 2022-10-04 08:34:30 +02:00
Valentin Gagarin 8e332a4a4e clarify scope 2022-10-04 08:34:30 +02:00
Valentin Gagarin 637cef7e10 add learning goals and prerequisites 2022-10-04 08:34:30 +02:00
Valentin Gagarin 397ed9f7d9 add instructions to run examples 2022-10-04 08:34:30 +02:00
Valentin Gagarin 95f364d714 reorder language properties, add dynamic typing 2022-10-04 08:34:30 +02:00
Valentin Gagarin 670c8e2d80 add alternative to @ syntax 2022-10-04 08:34:30 +02:00
Valentin Gagarin 50a21f1fbc do not claim rec is not suitable for static analysis 2022-10-04 08:34:30 +02:00
Valentin Gagarin 00f1366b7b fix typo 2022-10-04 08:34:30 +02:00
Valentin Gagarin 884b7858be draft: nix language tutorial
based on @tazjin's tazjin/nix-1p [1] and @zimbatm's NixCon 2019 talk "Reading The Nix Language" [2]

[1]: https://github.com/tazjin/nix-1p
[2]: https://youtu.be/hbJkMl631FE?t=1572
2022-10-04 08:34:30 +02:00
Valentin Gagarin f12180065f
Wil T -> Wil Taylor 2022-10-03 14:23:24 +02:00
Guillaume Desforges 2fd46b430f
Update source/recommended-reading.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-09-30 11:20:37 +02:00
Valentin Gagarin cd0759d2af
Merge pull request #320 from sbruder/highlight-shell-io
add highlighting for shell input/output
2022-09-30 01:50:22 +02:00
Domen Kožar 22ae50fb76
Merge pull request #326 from worktheclock/patch-9
Building and running Docker images RITZA edit
2022-09-26 13:38:51 +02:00
Domen Kožar 9dac52e1f1
Merge pull request #327 from worktheclock/patch-10
Cross compilation RITZA edit
2022-09-26 13:38:25 +02:00
worktheclock 0bdb1b2b50
Install Nix RITZA edit 2022-09-26 13:19:18 +02:00
worktheclock fe84721779
Cross compilation RITZA edit 2022-09-26 13:13:01 +02:00
worktheclock 4c4ca4ceb5
Building and running Docker images RITZA edit 2022-09-26 11:06:56 +02:00
Guillaume Desforges 3415f9a236
Add section "Videos" to recommended-reading.md
This list was provided to me by @fricklerhandwerk and sounds like a reasonable collection.
2022-09-12 16:22:48 +02:00
Simon Bruder dfcbbc0858
add highlighting for shell input/output 2022-09-08 11:09:27 +02:00
Robin Stumm 945e20d0c7 fix git version in example
broken in 5e0ba5f66b
2022-09-02 10:51:59 +02:00
Domen Kožar 5ccb0554ba
Merge pull request #315 from fricklerhandwerk/install-nix
update installation instructions
2022-09-01 20:22:50 +01:00
Valentin Gagarin c32dd69a0a
Merge pull request #301 from fricklerhandwerk/recommended-videos
update list of recommended Nix language tutorials
2022-09-01 19:25:46 +02:00
Valentin Gagarin a91c3e3c8c update installation instructions
Darwin no longer needs special incantations
2022-09-01 19:09:22 +02:00
Valentin Gagarin e475697073 fix typo 2022-08-28 14:28:10 +02:00
Domen Kožar 103a5f2246
Merge pull request #306 from idrisr/patch-1
Update glossary.md
2022-08-20 14:04:56 +02:00
Valentin Gagarin c856a39017 fix rendering issue with nested markdown 2022-08-18 19:16:22 +02:00
Idris Raja 02f4440c83
Update glossary.md
add definition for attribute name
2022-08-16 13:55:11 -05:00
Valentin Gagarin ecaded08f9 update site description
- it's multiple guides
- simpler sentence structure
- now missing "developers", but no obvious way to include it in
a grammatically correct way
2022-08-11 04:57:21 +02:00
Valentin Gagarin e9eb67bf63 update list of recommended Nix language tutorials
removed:
- Learn X in Y minutes is barely readable and not a tutorial but an
overview
- Nix by example is from 2014, has chaotic structure, and is oriented towards functional programmers
2022-08-10 01:59:47 +02:00
Domen Kožar 6920ac8dde
Merge pull request #293 from fricklerhandwerk/search-path
rework notes on search paths
2022-08-05 16:18:19 +02:00
Domen Kožar 30c5de2437
Merge pull request #294 from fricklerhandwerk/master
update sponsor sidebar
2022-08-05 16:16:38 +02:00
Andrei Boar 9131c1b530 add bob.build to Software Nix has influenced 2022-08-04 16:30:50 +03:00
Valentin Gagarin 5480aa9fd7 update sponsor sidebar 2022-08-02 12:56:48 +02:00
Valentin Gagarin 42e5ab74a5 rework notes on search paths
remove duplication so we can link to the respective section from the
language tutorial
2022-08-01 11:54:55 +02:00
worktheclock 99abfff9df
Build a bootable ISO image RITZA language edit
Language edit done by RITZA.
2022-07-21 12:00:26 +02:00
Domen Kožar b7fa967792
Merge pull request #258 from worktheclock/patch-7
Ad hoc developer environments RITZA language edit
2022-07-12 11:52:54 -05:00
Domen Kožar 2bad219af5 fix a link 2022-06-27 10:39:57 -05:00
Domen Kožar e59cbb3638 fix build 2022-06-27 10:35:35 -05:00
worktheclock fef2f37846
Ad hoc developer environments RITZA language edit 2022-06-20 13:07:31 +02:00
Max Kalashnikoff 808de6c0fb
Fixing ./result/bin/myapp.py -> ./result/bin/myapp
After the `nix-build` command the result app bin is `myapp` and not `myapp.py`.
2022-05-02 14:18:21 +05:30
worktheclock 5a62ec9c1b
NixOS on Raspberry Pi RITZA language edit 2022-04-11 14:52:24 +02:00
Nejc Zupan 02ced7bbff Proof-of-Concept for testing code samples
There are a number of code samples throughout nix.dev. How do we know
they still work? We don't!

This commit introduces a way for us to extract these code samples into files
and then run tests against them in CI. This will hopefully help us catch
regressions in future updates to nix, NixOS and/or this guide.

Additionally, I included a darwin specific nix-shell configuration that I
use personally on my M1 Mac to work on this repo. Might be useful for someone.
2022-04-07 10:16:17 +01:00
Domen Kožar 68416183e3
Merge pull request #241 from Michael-J-Ward/patch-2
Add note on multi-line shebang
2022-03-30 10:10:18 +01:00
Michael-J-Ward da980645ab
Update source/tutorials/ad-hoc-developer-environments.md
per @domenkozar's suggestion

Co-authored-by: Domen Kožar <domen@enlambda.com>
2022-03-29 09:49:55 -04:00
Domen Kožar 69070ee4a8
Merge branch 'master' into patch-4 2022-03-29 10:28:38 +01:00
Domen Kožar 5e0ba5f66b bump pins in ad-hoc tutorial 2022-03-29 10:22:29 +01:00
Britton Robitzsch 5221472a57
Update formatting issues for niv show and niv modify
Two commands were formatted as quotes instead of code. This caused an issue where --branch was formatted with '–' instead of '--'. This caused an error when copying and pasting the command into a terminal:
```
[nix-shell:~/niv]$ niv modify nixpkgs –branch nixos-21.05
Invalid argument `–branch'

Usage: niv [-s|--sources-file FILE] [--no-colors] COMMAND
```
2022-03-21 16:39:57 -06:00
Michael-J-Ward b0b9be629c
Add note on multi-line shebang
The multi
2022-03-16 00:42:05 -04:00
worktheclock 67e9357985
Pinning Nixpkgs RITZA proofread 2022-03-14 13:26:25 +02:00
Jan Tojnar b141d8b9a6
faq: Update deprecated Nix settings on NixOS 2022-02-07 16:43:35 +01:00
worktheclock e659bece62
Set up dev env RITZA language edit 2022-01-27 08:43:01 +02:00
Valentin Gagarin dbd0b8cfc4 more detail on specifying host platform
- explain mechanism of combining build and host platform in `nixpkgs` configuration
- add examples how to specify host platform in different ways
2021-12-15 12:03:44 +01:00
Valentin Gagarin 671e1d464d clarify platform attr vs. config string 2021-12-15 12:03:44 +01:00
Valentin Gagarin 12004ac36f add note on historicity platform encoding
there have been discussions around migrating the platform description to a more structured representation like an attribute set (cannot find relevant issue for reference right now), and it is worth noting that this string encoding is fairly arbitrary.
2021-12-15 12:03:44 +01:00
Valentin Gagarin c3fe9d754c reword distinction of target and host
use shorter sentences, emphasize keywords
2021-12-15 12:03:44 +01:00
Valentin Gagarin dd2b939f89
reword note on Nix community
make clear `nixpkgs` is the package collection, which is not the same as `nix` the package manager or the broader Nix community
2021-12-15 10:37:01 +01:00
Nejc Zupan e5e8253278 Convert the remaining tutorials from .rst to .md 2021-12-10 14:53:53 +00:00
Nejc Zupan 205e31841c Convert cross-compilation.rst
Note that the footnotes are now really in the foot of the document,
not at the foot of the paragraph.
2021-12-10 14:38:32 +00:00
Nejc Zupan 6d066825ec Converting moar tutorials 2021-12-10 14:34:01 +00:00
Nejc Zupan 38ca026b8f Start converting tutorials from .rst to .md 2021-12-10 14:10:26 +00:00
Nejc Zupan 1bcadb5175 Convert templates/*.rst to .md 2021-12-10 12:26:10 +00:00
Nejc Zupan 81339ce4f8 Convert reference/*.rst to .md 2021-12-10 12:24:12 +00:00
Nejc Zupan 499108ef7f Convert anti-patterns/*.rst to .md 2021-12-10 12:14:41 +00:00
Nejc Zupan 2c424a1310 Convert index.rst to .md 2021-12-10 11:36:13 +00:00
Nejc Zupan d251c52c74 Convert recommended-reading.rst to .md 2021-12-10 11:36:13 +00:00
Nejc Zupan 8ce1cbb01a Convert glossary.rst to .md 2021-12-10 11:15:01 +00:00
Nejc Zupan 7b7fe3c9c9 Convert faq.rst -> faq.md 2021-12-09 13:22:59 +00:00
Nejc Zupan 54ed4ce8ce Initial support for MyST
For now, we can have both .rst and .md files, so we can do the convertion
to Markdown iteratively.
2021-12-09 12:45:57 +00:00
Domen Kožar 04a0d31506
bump install-nix-action 2021-12-09 12:46:23 +01:00
nikstur 2d8e7b2c6d Fixed image name in dd command 2021-12-09 04:11:15 +01:00
Nejc Zupan ca2f7b4a95 fix a bunch more links 2021-12-06 16:48:55 +00:00
Nejc Zupan 8633fe329f fix install links, and typos 2021-12-06 16:48:55 +00:00
Nejc Zupan 7898fb3eb6 Fix link to building own NixOS image
The link changed in 2937038bf3
2021-12-06 16:48:55 +00:00
Domen Kožar c05d7c786b
Merge pull request #204 from urbas/aarch64-hydra-job
new hydra link to the aarch64 sd image
2021-12-04 15:06:12 +00:00
Matej Urbas d4a8e02b75 new hydra link to the aarch64 sd image 2021-12-04 13:14:58 +00:00
Walfie d7329e7032 Fix typos 2021-12-03 16:38:15 -05:00
Gurjeet Singh 817e04a4ae Remove duplicate example in "Pinning" section 2021-11-22 14:47:46 -08:00
Domen Kožar bf6a0b5caf bump install-nix-action 2021-11-12 15:09:25 -06:00
Domen Kožar 86206f316c
nix-install-action@v14.1 2021-11-03 06:04:49 -06:00
Eli Flanagan 32ce1e7b41
remove needless code fence
These came through raw on the webpage
2021-10-25 10:14:16 -04:00
Domen Kožar 3da134a71a
Add Nix language reference onepager 2021-10-20 06:27:14 -05:00
Domen Kožar aa2ac1ea46 read more: add more resources 2021-10-19 17:53:04 -05:00
Domen Kožar efc2a1b34b fix build 2021-10-19 16:42:37 -05:00
Domen Kožar 3b5d6302f2 fix #187 2021-10-19 16:35:11 -05:00
Domen Kožar 8474297cea
Merge pull request #189 from ritza-co/GitHub-actions-proofread
Update continuous-integration-github-actions.rst
2021-10-19 16:30:55 -05:00
Domen Kožar bb4365f9c0
TOC: start with the first tutorial for dev environments 2021-10-19 15:51:49 -05:00
worktheclock f16f7b22e2
Update continuous-integration-github-actions.rst 2021-10-18 11:46:37 +02:00
Domen Kožar 6b95160fe9
iso: fix NIX_PATH propagation
4 years old bug https://github.com/NixOS/nix/issues/1294
2021-10-04 16:32:29 -05:00
Samuel Gräfenstein 154bebe2e8
fix typos 2021-10-03 21:01:57 +02:00
Jörg Thalheim 9ca2a9a3f6 add short hacking tutorial for nixpkgs with docker
This example is intentionally a bit more verbose as docker might be used
by upstream authors to test package in nixpkgs without having to install
nix.
2021-09-30 09:12:31 +02:00
Domen Kožar 46e07de7aa installation: split by OS 2021-08-19 15:20:38 +02:00
Domen Kožar b831f236f1
Merge pull request #176 from nix-dot-dev/linkcheck
CI: run linkcheck
2021-08-19 10:05:32 +02:00
Domen Kožar 77dd9ef3cc typo 2021-08-19 10:03:27 +02:00
Domen Kožar 37cfce678c CI: run linkcheck 2021-08-19 10:01:13 +02:00
Alex Jackson 5046487ded fix broken link in raspberry pi tutorial 2021-08-18 08:38:31 -05:00
Domen Kožar f91886ce27 add meta descriptions 2021-08-11 10:45:46 +02:00
Domen Kožar 2bc822cfe2
Typo 2021-08-06 22:09:13 +02:00
Domen Kožar 126ad72eed docker images: mention macOS support and refresh next steps 2021-08-05 13:28:24 +02:00
Domen Kožar 601e79bcb4 building iso: changes based on feedback 2021-08-05 11:50:19 +02:00
Domen Kožar 705c71f3a2
Merge pull request #171 from nix-dot-dev/building-image
tutorial: building bootable ISO image
2021-08-02 14:53:00 +02:00
Domen Kožar 7db7db49ed
tutorial: building bootable ISO image 2021-08-02 14:48:42 +02:00