Commit Graph

1570 Commits

Author SHA1 Message Date
Silvan Mosberger
b6700a9c45 Review in meeting 2023-11-23 17:09:24 +01:00
Silvan Mosberger
fb3fb0c060
Update source/tutorials/file-sets.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-23 15:58:44 +01:00
Silvan Mosberger
9ecfd01a0d Remove unecessary non-fileset part 2023-11-22 21:47:35 +01:00
Silvan Mosberger
69e6dd6d9d Some changes from a full read 2023-11-22 21:32:14 +01:00
Silvan Mosberger
6afd231b97 Some updates
Use master branch (nixos-unstable doesn't have maybeMissing yet)
2023-11-22 20:45:16 +01:00
Silvan Mosberger
e4700af5e7
Update source/tutorials/file-sets.md 2023-11-22 20:29:23 +01:00
Silvan Mosberger
67b688adb6 Don't use nix.conf 2023-11-22 20:20:50 +01:00
Silvan Mosberger
b3f67ce6de Combine two paragraphs 2023-11-22 20:18:30 +01:00
Silvan Mosberger
3b2dfd8fb0 Minor changes after review 2023-11-22 20:15:03 +01:00
Silvan Mosberger
3befcc49f9
Apply suggestions from code review
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-22 19:37:16 +01:00
Silvan Mosberger
0d60facb04 inputs -> sources 2023-11-22 13:38:10 +01:00
Silvan Mosberger
bc00f00c5c More consistency in using diffs and prompts 2023-11-22 06:35:26 +01:00
Silvan Mosberger
a2ac364b8c Add Git to Vale's vocab 2023-11-22 05:35:23 +01:00
Silvan Mosberger
8e3032aa41
Merge pull request #806 from fricklerhandwerk/source-file-selection-review
review pass on tutorial sections
2023-11-22 05:32:53 +01:00
Silvan Mosberger
993bbc1787
Apply suggestions from code review 2023-11-22 05:30:16 +01:00
Silvan Mosberger
16db564126
Update source/tutorials/file-sets.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-22 05:25:51 +01:00
Silvan Mosberger
429bbb0621
Update source/tutorials/file-sets.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-11-22 05:24:47 +01:00
Valentin Gagarin
fa037e69f6
fix omission
Co-authored-by: Silvan Mosberger <github@infinisil.com>
2023-11-22 05:19:27 +01:00
Valentin Gagarin
3d6ac0aaec review pass on tutorial sections
it's a huge diff, but it doesn't change that much:
- start with a `mkDerivation` scaffold that uses `src = ./.`
  - this saves the detour with an intentionally broken derivation and
    the explanation it requires
  - it provides an opportunity to drop another bit of information about
    `toSource`, namely that it always creates a directory in the store
- use two source files to start with, otherwise the "try one file, then
  the whole directory" approach is not well-motivated
  - this obviates spending words on justifying a contrived example,
    it flows more naturally
- mostly use diffs to highlight the changes
  - this is not a strong proposal
  - the explicit-include-union example starts over, so the build-up is
    manageable
  - it works out quite nicely overall: since there is sufficient repetition
    where we reasonably expect learners to have gotten the point,
    the last two sections can be reduced just to the relevant bit.
- rename section headers to match functions, not domain problems
  - one exception is the split of the two union approaches, which should
    be okay
- reword all instructions to be imperative

the review made clear how powerful and elegant the library is, and that
the tutorial is utterly well-structured and ordered in a way that feels
natural and covers all important aspects!

great job!
2023-11-22 04:29:12 +01:00
Valentin Gagarin
efe4ba44a1 simplify conclusion
- readers may not have literally seen the examples
- "combinators" isn't even used in reference documentation and is
  a potentially scary word. it doesn't even convey additional meaning
  here, since combination ("two together") and composition ("put
  together") are almost the same, composition being more general.
2023-11-22 04:29:08 +01:00
Valentin Gagarin
ba4989c49f follow convention from niv guide 2023-11-22 04:29:07 +01:00
Valentin Gagarin
501a5f7cf4 add instruction to add a source file
otherwise the examples don't actually work
2023-11-22 04:29:06 +01:00
Valentin Gagarin
a6e5f2675f package.nix -> build.nix
this follows the convention established in other tutorials.

also arguably, this file is *not* the package per se, but simply contains a representation of build instructions.
2023-11-22 04:29:05 +01:00
Valentin Gagarin
51a78a0bd4 channel -> channel branch
this follows the convention established in the FAQ on releases
2023-11-22 04:29:03 +01:00
Valentin Gagarin
152953ef30 A local directory -> Example project
- more telling section title
- use imperative in instructions
2023-11-22 04:29:02 +01:00
Valentin Gagarin
767155bc15 trim down phrasing 2023-11-22 04:29:01 +01:00
Valentin Gagarin
fb6f6302d0 add link to flakes documentation, add emphasis 2023-11-22 04:28:59 +01:00
Valentin Gagarin
97bbe4fcf7 restructure notes on copying files 2023-11-22 04:28:58 +01:00
Valentin Gagarin
568925ec8f move tip before the other notes
three highlight boxes in a row seem a bit too much, also the tip is
relevant immediately after the first example.
2023-11-22 04:28:51 +01:00
Valentin Gagarin
5ca3739c36 shorten introduction to path arguments 2023-11-22 04:28:50 +01:00
Valentin Gagarin
9fd9700c88 use log ellipsis as in the other tutorials
brackets in console output invoke weird associations, as they could be
syntactically relevant. bare ellipses are unusual enough one can expect
them to be intuitively parsed as artificial.
2023-11-22 04:28:49 +01:00
Valentin Gagarin
76905abea7 shorten introduction to trace 2023-11-22 04:28:49 +01:00
Valentin Gagarin
d388d6d633 add link to command reference 2023-11-22 04:28:48 +01:00
Valentin Gagarin
06caaae956 clarify wording 2023-11-22 04:28:47 +01:00
Valentin Gagarin
8402ecf299 Basics -> File sets
since the title is now different, we can be more specific on what the
first section is about: file sets, generally.
2023-11-22 04:28:47 +01:00
Valentin Gagarin
7e7c6d79bb reword learning objective
- sharpen the value proposition of the library
- this meshes with and expands on the new title
2023-11-22 04:28:45 +01:00
Valentin Gagarin
6a61be9811 clarify wording 2023-11-22 04:28:44 +01:00
Valentin Gagarin
285fd17c1d shorten introduction
- link to reference documentation on the `builder` executable
- since the sandbox is enabled by default, we can just say that
2023-11-22 04:28:42 +01:00
Valentin Gagarin
17e859e53b more informative title 2023-11-22 04:26:37 +01:00
Silvan Mosberger
bd3a71f64f
Update source/tutorials/file-sets.md 2023-11-21 21:48:04 +01:00
Silvan Mosberger
f8427e5328 Minor change 2023-11-21 19:16:13 +01:00
Silvan Mosberger
436b4aa1b9 Briefly mention problems with builtin features 2023-11-21 18:29:32 +01:00
Silvan Mosberger
33ff09d6cd Polish 2023-11-21 03:35:35 +01:00
Silvan Mosberger
02ae281b70 Complete content 2023-11-21 02:41:04 +01:00
Silvan Mosberger
988945c40c Move file 2023-11-21 01:40:41 +01:00
Silvan Mosberger
de1e74281d Rewrite to be about file sets 2023-11-21 01:02:06 +01:00
Silvan Mosberger
6582681bd3 Expand on file sets 2023-11-20 21:46:54 +01:00
Silvan Mosberger
239f2d9678 Updates 2023-11-20 06:02:44 +01:00
Silvan Mosberger
836b6cde50 Updates 2023-11-20 00:38:18 +01:00
Silvan Mosberger
197782d1b4 Updates 2023-11-20 00:00:29 +01:00