NixOS/nix.dev
NixOS/nix.dev
1
0
Fork 0
mirror of https://github.com/NixOS/nix.dev.git synced 2024-10-18 14:32:43 -04:00
Code Activity
1261 commits 15 branches 0 tags 6.2 MiB
Commit graph

718 commits

Author SHA1 Message Date
Valentin Gagarin 1dd5699888 less strict wording 2022-10-04 08:34:33 +02:00
Valentin Gagarin d2cad3d48e clarify nested functions with parentheses 2022-10-04 08:34:33 +02:00
Valentin Gagarin de6128a8f8 chaining arguments -> multiple arguments 
"chaining arguments" is not well-defined, as [noted] by @matta

[notes]: https://github.com/NixOS/nix.dev/pull/267/files#r968597277
 2022-10-04 08:34:33 +02:00
Valentin Gagarin f66543da01 Nix language -> the Nix language 
as [pointed out] by @matta

[pointed out]: https://github.com/NixOS/nix.dev/pull/267/files#r968574463
 2022-10-04 08:34:33 +02:00
Valentin Gagarin ff2c457f32 reword; there are also invalid expressions 2022-10-04 08:34:33 +02:00
Valentin Gagarin e9af30a6ff shorten time estimate 
move the section further up, as recommended by @infinisil
 2022-10-04 08:34:33 +02:00
Valentin Gagarin d910383580 capitalize list items 
according to English style guides such as [1]

[1]: https://www.instructionalsolutions.com/blog/bulleted-list-punctuation
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 93706c411e add notes on strict evaluation 2022-10-04 08:34:33 +02:00
Valentin Gagarin 109ae74e94 Update source/tutorials/nix-language.md 
Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin aaea5b42c0 Update source/tutorials/nix-language.md 
Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 1fcaaea3b0 Update source/tutorials/nix-language.md 
Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 68c33e7ed1 Update source/tutorials/nix-language.md 
Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 7474d830a1 Update source/tutorials/nix-language.md 
Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 90522e865f expressions are transformed, not simplified 
@infinisil: This is a bit misleading, the model isn't that expressions get simplified. Instead it's that each expression type has semantics for how it should be turned into a Nix value.

Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 14455c1d86 evaluate to Nix value, not just value 
@infinisil: Introducing the concept of a Nix value fits very well here

Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin e5260f3d6d libraries are not just functions 
Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 55eb91bd9e stdenv -> stdenv.mkDerivation 
@infinisil: `stdenv` itself is not a builder

Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 5938ad044b remove "and" from example list 
@infinisil: The "and" would indicate the end of the list

Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 506b35311e libraries have more things than functions 
Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 30d76c858b use less ambiguous grammar for what NixOS is 
Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin abf0f5e6d3 use consistent grammatical structure in requirements 
Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 95ce02b793 update Nix manual URLs 2022-10-04 08:34:33 +02:00
Valentin Gagarin 8ac15f8a08 Update source/tutorials/nix-language.md 
Co-authored-by: Dan Baker <daniel.n.baker@gmail.com>
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 78a43fb28f use consistent terminology 
sort out derivation, Derivation, `derivation` and store derivation
 2022-10-04 08:34:33 +02:00
Valentin Gagarin adaba6637e fix wording 2022-10-04 08:34:33 +02:00
Valentin Gagarin e0ee7d5597 link to installation instructions 2022-10-04 08:34:33 +02:00
Valentin Gagarin 17bf23546a rework section on side effects 2022-10-04 08:34:33 +02:00
Valentin Gagarin 397a39f9de mention operators 
at some point we have to introduce them, even if they are not really
important here.
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 8f1dd17106 add proper examples to file system paths 2022-10-04 08:34:33 +02:00
Valentin Gagarin c36c6ed732 rewordings and links 2022-10-04 08:34:33 +02:00
Valentin Gagarin 8a4d87474b add detailed explanations to some examples 2022-10-04 08:34:33 +02:00
Valentin Gagarin cd7e00ba8d reword time estimate 2022-10-04 08:34:33 +02:00
Valentin Gagarin bb9e7d7ab3 Nix package manager -> Nix 
based on https://github.com/NixOS/nix.dev/issues/275#issuecomment-1227572104
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 7e18f44302 add introduction and cross-linking 
this should both help with initial overview and navigation
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 5851659340 add detailed explanation to let expression 2022-10-04 08:34:33 +02:00
Valentin Gagarin 4253a0bc7a nixpkgs/lib -> pkgs.lib 
this is probably how most people would encounter it, but since there are
so many equivalent representations, maybe it does not matter outside
a dedicated guide to Nixpkgs
 2022-10-04 08:34:33 +02:00
Valentin Gagarin 922e018fd6 nixpkgs -> Nixpkgs 
based on https://github.com/NixOS/nix.dev/issues/275#issuecomment-1227572104
 2022-10-04 08:34:33 +02:00
Valentin Gagarin b084005748 fix copypaste error 2022-10-04 08:34:33 +02:00
Valentin Gagarin aa0bf42491 fix typo in link 2022-10-04 08:34:33 +02:00
Valentin Gagarin 55c4d4feca attempt at detailed explanation 2022-10-04 08:34:33 +02:00
Valentin Gagarin dfc6d1c31f standard -> function 2022-10-04 08:34:33 +02:00
Valentin Gagarin ab8784c2ad add links to next steps 2022-10-04 08:34:33 +02:00
Valentin Gagarin aebc9e91b1 clarifications 2022-10-04 08:34:33 +02:00
Valentin Gagarin d770b13aef add links, fixups 2022-10-04 08:34:33 +02:00
Valentin Gagarin 8ee55cbac1 expand on side effects, add next steps 2022-10-04 08:34:33 +02:00
Valentin Gagarin c9f5ac3f1f show store paths and fetchers 2022-10-04 08:34:33 +02:00
Valentin Gagarin 3a86358dbf add TODO for operators 2022-10-04 08:34:33 +02:00
Valentin Gagarin 92f96cab30 more explicit explanation of partial evaluation 2022-10-04 08:34:33 +02:00
Valentin Gagarin 95f98f6a60 more explicit syntax notes 2022-10-04 08:34:33 +02:00
Valentin Gagarin f791bd4875 nixpkgs is a token 2022-10-04 08:34:33 +02:00
Valentin Gagarin cf0292e470 restructure introduction, show elements of programming 
this does not take away information, but presents it in a different
order. put emphasis on that the language does not do all that many
things.
 2022-10-04 08:34:33 +02:00
Valentin Gagarin ee6f1e1c33 generate anchors down to heading level 3 2022-10-04 08:34:33 +02:00
Valentin Gagarin d33eedadd3 add imports to side effects 2022-10-04 08:34:33 +02:00
Valentin Gagarin 20789513e8 notes on argument structure 2022-10-04 08:34:33 +02:00
Valentin Gagarin e7807baa57 clarify explanation of nested functions 2022-10-04 08:34:33 +02:00
Valentin Gagarin 9a994092c2 function calls aka function application 2022-10-04 08:34:33 +02:00
Valentin Gagarin 6390aae686 remove superfluous empty line 2022-10-04 08:34:32 +02:00
Valentin Gagarin bd4118ebb2 move search paths to values section 2022-10-04 08:34:32 +02:00
Valentin Gagarin 9b158e60d1 clarify inheriting from attribute 2022-10-04 08:34:32 +02:00
Valentin Gagarin 6c903a6ccf clarify requirements of being able to read code 2022-10-04 08:34:32 +02:00
Valentin Gagarin b0023d2ade add subsections to modes of running examples 
reorder to have the REPL first (it's fewer steps)
 2022-10-04 08:34:32 +02:00
Valentin Gagarin 155ad688bc explain how to read examples 2022-10-04 08:34:32 +02:00
Valentin Gagarin 6a4e69eef1 remove paths and strings from top-level outline 2022-10-04 08:34:32 +02:00
Valentin Gagarin 2406c22293 emphasize what this guide is about 2022-10-04 08:34:32 +02:00
Valentin Gagarin 61524d0d34 expressions can be nested 2022-10-04 08:34:32 +02:00
Valentin Gagarin 40ca6fc799 note on difference between antiquotation and shell vars 2022-10-04 08:34:32 +02:00
Valentin Gagarin b3a42cffdc expand on strings and antiquotation 
move section into "names and values": it should be short enough not to
exhaust readers before we get to functions, and would not make much
sense as an afterthought to functions.
 2022-10-04 08:34:32 +02:00
Valentin Gagarin ca37fe15b0 regularize function examples 2022-10-04 08:34:32 +02:00
Valentin Gagarin 43f2895b2c add counter-example to attribute set argument 2022-10-04 08:34:32 +02:00
Valentin Gagarin 23b52d351e add subsection heading 2022-10-04 08:34:32 +02:00
Valentin Gagarin 560268d865 add missing colon 2022-10-04 08:34:32 +02:00
Valentin Gagarin 9015962289 make example explicit 2022-10-04 08:34:32 +02:00
Valentin Gagarin c6a1c90bbf tighter inherit notation 2022-10-04 08:34:32 +02:00
Valentin Gagarin db56937ab3 add developer tools to skills outline 2022-10-04 08:34:31 +02:00
Valentin Gagarin 075df5b67b give language properties more structure 2022-10-04 08:34:31 +02:00
Valentin Gagarin 41250bb231 reorder first sentences 2022-10-04 08:34:31 +02:00
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
Domen Kožar 458f1bfdf2
Update source/tutorials/install-nix.rst 2021-07-22 10:05:11 +02:00
Tom Bereknyei c2d98ff2b1 Add docker install 2021-07-21 16:23:57 -04:00
Domen Kožar c677998720
Cleanup sidebar 2021-07-20 10:55:50 +02:00
Domen Kožar 4e0b44622f
Merge pull request #166 from nix-dot-dev/rpi-firmware 
rpi: suggest updating firmware in case image doesn't boot
 2021-07-07 14:19:35 +02:00
Domen Kožar a40c10277f
rpi: suggest updating firmware in case image doesn't boot 2021-07-07 13:54:04 +02:00
Domen Kožar 7bc44fdddd
index: remove Topics 2021-06-28 22:18:14 +02:00
sterni d087303b04
cross-compilation: fix platform terminology in shell example 
* `nativeBuildInputs` is roughly equivalent to taking a package from `buildPackages` which
  means that *its* host platform is the build platform of the derivation (so we can execute it during
  the build) and its target platform is the host platform of the derivation (so e. g. compilers produce
  binaries that can be executed where we want them to)
* `buildInputs` are needed on the *host* platform of the derivation
* What would the target platform be in this case? It would only be relevant if we were to build a
  cross-compiler: Then we'd need runtime libraries for the target platform, for example.
 2021-06-24 13:21:06 +02:00
Domen Kožar a56f127f18
Less articles 2021-06-23 19:38:58 +02:00
Domen Kožar 11c4f6dd20
Articles 2021-06-23 19:37:46 +02:00
Domen Kožar 00093ddd9f
fix edit button 2021-06-23 19:37:11 +02:00
Domen Kožar d177dba53b
theme: alabaster -> sphinx_book_theme 2021-06-23 18:51:43 +02:00
Domen Kožar eb36297f5c
index: link to cross compilation tutorial 2021-06-18 11:45:15 +02:00
Domen Kožar ec9298d348
Merge pull request #160 from nix-dot-dev/cross-compilation-tutorial 
Tutorial for cross-compilation
 2021-06-17 15:01:50 +02:00
Domen Kožar 608df83a50
feedback 2021-06-17 11:01:07 +02:00
Domen Kožar 3729167720
Update source/tutorials/cross-compilation.rst 
Co-authored-by: John Ericson <git@JohnEricson.me>
 2021-06-16 15:36:13 +02:00
Domen Kožar 7b7c8360ff
Merge branch 'master' into cross-compilation-tutorial 2021-06-16 09:32:16 +02:00
Domen Kožar 44156f8bcc
Going forward -> Next steps 2021-06-15 16:58:33 +02:00
Domen Kožar bee6cd582d
map benefits to tutorials 2021-06-15 16:56:41 +02:00
Domen Kožar 9d4e7e6362
Merge branch 'cross-compilation-tutorial' into patch-2 2021-06-15 16:47:42 +02:00
Domen Kožar 4604ab5e58
feedback 2021-06-15 15:53:10 +02:00
Kim R2 df7523b23e
Language edit 2021-06-15 15:41:39 +02:00
Domen Kožar a928ff1dd3
feedback 2021-06-15 12:51:46 +02:00
Domen Kožar 365c3989b0
Tutorial for cross-compilation 2021-06-14 18:59:58 +02:00
Ilan Joselevich 24cc5d249c
Reverting terraform reference changes 
Reverted due to Terraform's AWS image not being released for 21.05 yet.
 2021-06-13 18:30:40 +03:00
Ilan Joselevich 9a554fd04f replace all mentions of 20.03 and 20.09 with 21.05 2021-06-13 14:21:02 +03:00
Kim R2 eb55acc612
language edit 2021-06-07 13:08:36 +02:00
Domen Kožar dedcd7b6b3
Add tutorial for integration testing using virtual machines 2021-06-03 22:23:01 +02:00
Domen Kožar 4189437245
fix linkcheck 2021-06-03 21:21:15 +02:00
Domen Kožar 906250b4bd
expose 3rd level of subsections for easiler discoverability 2021-06-03 14:10:13 +02:00
Domen Kožar afa30c5d65
Merge pull request #149 from jonringer/fix-faq-code-blocks 
FAQ: put sqlite commands in a codeblock
 2021-05-20 07:17:16 +02:00
Jonathan Ringer 8fab39883e
Update home-manager link 
Has been moved since early 2021
 2021-05-19 16:49:20 -07:00
Jonathan Ringer 7040a9903e
FAQ: put sqlite commands in a codeblock 2021-05-19 15:39:03 -07:00
Domen Kožar a3bef3e312
bump cachix-action in the tutorial 2021-05-14 19:57:50 +02:00
Domen Kožar 506d542df8
pypi2nix -> mach-nix 2021-05-14 12:33:37 +02:00
Domen Kožar 9a88c8801a
Intro: tweak 2021-05-13 11:17:51 +02:00
Domen Kožar 0937e7e02b
rpi4: review tweaks 2021-05-13 11:17:51 +02:00
Domen Kožar 160c9e6817
rpi4: clarify on root/user commands 2021-05-13 11:17:51 +02:00
Domen Kožar 51b7acb197
rpi4: add Going Forward section 2021-05-13 11:17:50 +02:00
Domen Kožar 800781beeb
RPi -> Raspberry Pi 2021-05-13 11:17:50 +02:00
Domen Kožar 96e7fef67e
rpi4: be explicit 2021-05-13 11:17:50 +02:00
Domen Kožar a07ccb7e68
Apply suggestions from code review 
Co-authored-by: Samuel Dionne-Riel <samuel@dionne-riel.com>
 2021-05-13 11:17:50 +02:00
Domen Kožar 8f969f4595
Apply suggestions from code review 
Co-authored-by: Nejc Zupan <nejc.zupan@gmail.com>
 2021-05-13 11:17:50 +02:00
Domen Kožar 4b00f48479
Raspberry Pi tutorial 2021-05-13 11:17:48 +02:00
Domen Kožar 39a80a0b11
Allow readers to subscribe to email notifications for new content. 2021-04-30 17:45:17 +02:00
Gareth Dwyer 85e23ca44b
Update deploying-nixos-using-terraform.rst 2021-04-18 11:29:56 +02:00
Domen Kožar c50f05b61d
Update language.rst 2021-04-14 23:34:23 +02:00
Lucas Desgouilles 9f033c8ebe Showcase inherit as an alternative to with 2021-04-10 22:27:36 +02:00
Domen Kožar fffdde905e
fix date 2021-04-06 15:54:27 +02:00
Domen Kožar 8ffc25c13e
bump actions 2021-04-03 12:42:22 +02:00
Domen Kožar d3bfaaab07
terraform: mention execution mode to be local 2021-03-10 16:02:45 +00:00
Domen Kožar 32effd4763
terraform: more typos 2021-03-10 15:10:48 +01:00
Domen Kožar c932561487
terraform: typos 2021-03-10 15:05:31 +01:00
Robert Hensing d20e1d5927
building-and-running-docker-images: Set system 
This will help macOS users. While alternatives are possible[1]
this is the simplest solution.

1: https://github.com/NixOS/nixpkgs/pull/115083
 2021-03-04 19:26:12 +01:00
Ryan Mulligan 48de544f9c
fix grammar on install nix 2020-12-09 20:56:18 -08:00
Domen Kožar 7fa11091c5
contribuing: remove bogus sentence 2020-11-23 15:47:37 +01:00
Domen Kožar cc28a13cc7
fix linkcheck 2020-11-18 18:42:27 +01:00
Domen Kožar 03116cfee0
fix redirect 2020-11-18 18:38:24 +01:00
Domen Kožar 1108d0bde0
Add tutorial for deploying NixOS with Terraform 2020-11-18 18:38:24 +01:00
Domen Kožar 8db1b57c39
github actions: follow up with cachix API write tokens 2020-11-10 15:14:44 +01:00
Domen Kožar 38962b0e57
bump actions 2020-11-05 18:10:52 +01:00
Matthew Kenigsberg d5edd756bf Set maxdepth 2 to make homepage cleaner 
I personally found it hard to skim through details about a tutorial when
I just wanted to know what each one was about
 2020-10-19 16:17:56 -05:00
Elias Probst 507bf503c9
Correct minor typos in anti-patterns/language 2020-10-04 17:16:45 +02:00
Sylvain Bellemare 50000ce382
Remove semi-colon from fetchTarball example 2020-10-01 23:34:53 +01:00
Domen Kožar 8728dcf44d
github actions: install-nix-action v11 2020-09-21 16:01:16 +02:00
Jappie Klooster 8a71ffcd9e Refer to gitignoresource in case of ./. anti pattern 
Knowing about that significantly increased the ergonimics
of nix-shell for me. So I think it's good to mention it.
 2020-08-05 10:47:49 +02:00
Jon c05ab9cbb1
Mention nixpkgs-review for reverse dependencies 
nixpkgs-review is a little more featureful, and the tool I see used most often:
 2020-08-03 08:57:31 -07:00
Domen Kožar 253bf5e443
FAQ: What to do if a binary cache is down or unreachable? 2020-07-27 09:25:46 +02:00
Domen Kožar 9aa910fd8b
Merge branch 'master' into patch-1 2020-07-14 15:40:38 +02:00
Domen Kožar 9c729e7d28
Update source/tutorials/towards-reproducibility-pinning-nixpkgs.rst 2020-07-13 16:10:02 +02:00
Domen Kožar 247756b3ad
add nixos weekly 2020-07-13 13:21:00 +02:00
Domen Kožar 5b73996367
pinning: be more precise about filenames 2020-07-13 10:19:32 +02:00
Bryan Richter f89414ee00
Formulate niv example for use in default.nix 
I assume most people will try to use this in a top-level default.nix, as I did. :)
 2020-07-10 22:53:33 +03:00
Arian van Putten 2837ed935f
Update towards-reproducibility-pinning-nixpkgs.rst 2020-07-09 20:09:47 +02:00
Gareth Dwyer 0bd8a0b02f re-add header 2020-07-09 12:13:04 +02:00
Gareth Dwyer 992b8f9968 reproducibile shell edits 2020-07-09 12:09:24 +02:00
Domen Kožar e7e405aed5
garden 2020-07-08 23:20:17 +02:00
Domen Kožar b3ce59dcbb
domenkozar -> nix-dot-dev 2020-07-08 22:47:32 +02:00
Domen Kožar a213c370f5
fix #25: link getting started Nix template 2020-07-08 14:09:32 +02:00
Domen Kožar cab591c6cf
theme: note where the options come from 2020-07-08 10:46:10 +02:00
Domen Kožar 65c2130385
Switch to more modern variation of flask theme, alablaster 2020-07-08 10:44:04 +02:00
Domen Kožar cbf8cddc4e
typo 2020-07-07 16:58:18 +02:00
Domen Kožar 030805f226
Merge pull request #75 from nix-dot-dev/github-actions 
Continuous Integration with GitHub Actions
 2020-07-07 13:29:29 +02:00
Domen Kožar 4fcc556e3f
Update source/tutorials/continuous-integration-github-actions.rst 
Co-authored-by: zimbatm <zimbatm@zimbatm.com>
 2020-07-07 11:27:40 +02:00
Domen Kožar ebff7b7a20
direnv: make setup a heading 2020-07-07 10:49:02 +02:00
Domen Kožar 65508e2023
feedback 2020-07-07 10:26:09 +02:00
Domen Kožar bb55fbf8ad
Continuous Integration with GitHub Actions 2020-07-06 17:31:01 +02:00
Domen Kožar f2d8df94a8
typo 2020-07-06 10:09:50 +02:00
Lucas Desgouilles 82da1852e7
Fix typo in source/tutorials/contributing.rst 2020-07-05 16:29:02 +02:00
Casey Ransom ae30fb0163 builtins.path expects path, not src 2020-07-02 09:14:19 -04:00
Domen Kožar 76162ff983
Merge pull request #69 from domenkozar/merge-opreator-and-cwd 
Merge opreator and cwd
 2020-07-02 12:07:23 +02:00
Domen Kožar ca99e2bd21
anti-patterns: // operator and ./. path 2020-07-02 10:55:59 +02:00
Domen Kožar 091a24a680
anti-patterns: merge operator and cwd 2020-07-02 10:48:54 +02:00
Eduard Bopp 168e67a6b5 Fix errors in dev environment tutorial 2020-07-01 18:19:00 +02:00
Domen Kožar 0a2de10756
review 2020-07-01 15:54:41 +02:00
Domen Kožar 3885db3e94
rewrite tutorial on declarative environments 2020-06-30 14:50:02 +02:00
Damien Cassou faae37da83
Avoid with attrset; ... anti-pattern 2020-06-28 20:22:57 +02:00
Damien Cassou 561ac903a1
Quote URLs in Nix expressions 
Unquoted URLs are an anti-pattern that we recommend against.
 2020-06-28 20:18:55 +02:00
Domen Kožar 89d0c7d21c
Merge pull request #63 from sixhobbits/master 
docker edits
 2020-06-28 17:36:23 +02:00
Gareth Dwyer ce4da9f735 docker edits 2020-06-28 10:45:38 +02:00
Damien Cassou 3fd18b38ca
Small fix 2020-06-25 11:49:16 +02:00
Domen Kožar cc1e46b9e2
Update source/tutorials/building-and-running-docker-images.rst 2020-06-23 17:23:50 +02:00
Domen Kožar 4ba3c3f5a2
Apply suggestions from code review 2020-06-23 17:23:50 +02:00
Domen Kožar 7c69a4e50d
Update source/tutorials/building-and-running-docker-images.rst 2020-06-23 17:23:50 +02:00
Domen Kožar 9b455de5ec
Update source/tutorials/building-and-running-docker-images.rst 2020-06-23 17:23:50 +02:00
Eduard Bopp 479f8f8570
Link to nixpkgs manual 2020-06-23 17:23:50 +02:00
Eduard Bopp 2e7eb8dbdc
Apply suggestions from code review 
Co-authored-by: Domen Kožar <domen@enlambda.com>
 2020-06-23 17:23:49 +02:00
Eduard Bopp 94a8a7e794
Write tutorial about Docker images 2020-06-23 17:23:49 +02:00
Eduard Bopp b57a05066e Remove trailing whitespace from rst files 2020-06-21 14:26:51 +02:00
Gareth Dwyer 3482b93ded Merge remote-tracking branch 'origin/add-edits-towards-reproducibility' 2020-06-19 17:32:16 +02:00
Gareth Dwyer 9606ab9e82 edits for towards repro tutorial 2020-06-19 17:30:46 +02:00
Domen Kožar df649e8020
install Nix: 2.3.6 2020-06-18 10:36:42 +02:00
Domen Kožar 76236ca900
recommended reading: nix shorts 2020-06-17 21:44:20 +02:00
Domen Kožar 64c7fa54a1
don't recommend nixpkgs-channels anymore and bump NixOS version 2020-06-17 15:49:18 +02:00
Domen Kožar 0d2278384d
Note that Cachix is sponsoring this work 2020-06-16 16:02:14 +02:00
Domen Kožar 4c2cc9f1f7
Merge pull request #38 from ghuntley/this-page 
feature(thispage): add edit, history and source links
 2020-06-15 18:09:07 +02:00
Domen Kožar 481228864a
This page: make it work 2020-06-15 18:06:41 +02:00
Domen Kožar 6f0c64845e
<nixpkgs> anti pattern 2020-06-15 17:11:26 +02:00
Domen Kožar 03f8d1b07a
ad-hoc-environment: show the correct ouput 2020-06-15 17:03:45 +02:00
Kirill Zaborsky e392d700df
Minor improvements 
This is a bit subjective for s/`/``/ replacement but even in HTML generated by Sphinx gray spans on https://nix.dev/anti-patterns/language.html look much more prominent than italic (which is easy to miss and sentences using "with" become a bit confusing)
 2020-06-15 00:10:07 +03:00
Gareth Dwyer 96302feb9b Update source/tutorials/ad-hoc-developer-environments.rst 
Co-authored-by: Domen Kožar <domen@enlambda.com>
 2020-06-14 17:12:44 +02:00
Gareth Dwyer 7393a40727 tutorial edits 2020-06-14 17:12:44 +02:00
Geoffrey Huntley 9c84f7a601 feature(thispage): add edit, history and source links 2020-06-13 10:53:32 +00:00
Domen Kožar 02ac52284d
typo 2020-06-12 17:55:55 +02:00
Domen Kožar 3ebd096594
Merge pull request #33 from domenkozar/anti-patterns-rec 
Add rec anti pattern
 2020-06-12 16:40:06 +02:00