Commit Graph

1794 Commits

Author SHA1 Message Date
Valentin Gagarin
5e5ae63bf5 add more highlight boxes 2024-09-02 11:29:38 +02:00
Valentin Gagarin
def1303606 move note on documentation quality into highlight box 2024-09-02 11:29:38 +02:00
Valentin Gagarin
9c75769a3c update the tutorial guide, add issue template 2024-09-02 11:22:52 +02:00
Valentin Gagarin
9eeafb5ef0 update link to the Open Collective project 2024-09-02 10:06:18 +02:00
Jacek Galowicz
7e96226408
Add tutorial on setting up a binary cache (#1040)
* Add tutorial about binary cache setup

Co-authored-by: Valentin Gagarin <valentin@gagarin.work>
Co-authored-by: wamirez <wamirez@protonmail.com>
2024-08-31 19:45:14 +00:00
Valentin Gagarin
d879411922 update NixOS VM tutorial
- clarify prerequisites
- update Nixpkgs release to 24.05
- remove the NixOS special cases, they are not needed
- rework a few side notes

Co-authored-by: wamirez <wamirez@protonmail.com>
2024-08-31 19:46:16 +02:00
Valentin Gagarin
873f9162ef fix typos 2024-08-27 01:52:20 +02:00
Jacek Galowicz
0fbadb7bd7
Add tutorial about remote provisioning with nixos-anywhere (#1038)
Co-authored-by: Valentin Gagarin <valentin@gagarin.work>
2024-08-26 20:47:49 +00:00
Valentin Gagarin
a278f419aa simplify the headings recommendation 2024-08-26 22:43:34 +02:00
Valentin Gagarin
53a52a4183 expand on code samples 2024-08-26 22:43:34 +02:00
Valentin Gagarin
6b51983ba6 expand on which voice to use when 2024-08-26 22:43:34 +02:00
Valentin Gagarin
50bfb75f17 update rule on using reference links
the previous form hasn't been practice for a long time now, and has
proven to be counterproductive.
2024-08-26 22:43:34 +02:00
Jacek Galowicz
92f6419bca
restructure NixOS tutorials TOC (#1037)
Co-authored-by: Valentin Gagarin <valentin@gagarin.work>
2024-08-26 14:08:53 +02:00
Valentin Gagarin
53dff2387f
make building the manuals optional (#1035) 2024-08-24 17:52:19 +02:00
Attila Gulyas
ad5f266d3b
Clarify wording around nix-shell --run (#1027)
- clarify wording around what Nix actually does
- add a link to documentation of Bash commands

Co-authored-by: Valentin Gagarin <valentin@gagarin.work>
2024-08-15 15:28:13 +02:00
Attila Gulyas
b159d08ae3
Update towards-reproducibility-pinning-nixpkgs.md (#1029)
I expected the `<nixpkgs>` link to point to a resource that explains what that construct is and not directly to Nixpkgs. If I would be totally new to Nix, that would be even more confusing.
2024-08-14 22:05:53 +00:00
Valentin Gagarin
174bdff866
update Nix and Nixpkgs releases (#1033) 2024-08-14 19:21:54 +00:00
Valentin Gagarin
79517f35ad
fix broken link (#1034) 2024-08-14 19:06:28 +00:00
Attila Gulyas
a06dc94072
Add cross-reference (#1031)
Added the reference to the "_Package parameters and overrides with `callPackage`_" chapter because I actually started looking up info on `callPackage` as I missed it being mentioned in the sidebar.

Co-authored-by: Valentin Gagarin <valentin@gagarin.work>
2024-08-13 08:12:16 +00:00
Attila Gulyas
b0fb4ac4c6
Fix explanation of code snippet (#1028)
I presume that at one point there was only one package that was referred from `pkgs` and then another one was added later.
2024-08-13 08:07:59 +00:00
Olga Pilipenco
1c050ebb4d
Update Nixpkgs versions in "declarative shells" tutorial (#1023)
Co-authored-by: Valentin Gagarin <valentin@gagarin.work>
2024-07-31 19:48:43 +00:00
Valentin Gagarin
fd16ebaf0c update link to lastest build of the Nix manual 2024-07-28 14:43:06 +02:00
YSawc
d554da990f
working with local files: Add output example (#1025) 2024-07-25 12:59:11 +00:00
Olga Pilipenco
fc292e2cd6
Update Nixpkgs version in packaging tutorial (#1024) 2024-07-19 00:33:00 +00:00
Will Bush
d0c9ed4e99 fix mkShellNoCC to use packages instead of buildInputs
According to:
cdd059f7e5/source/tutorials/first-steps/declarative-shell.md (L84)

>The `packages` attribute argument to `mkShellNoCC` is simply an alias for `nativeBuildInputs`.

I believe https://github.com/NixOS/nix.dev/issues/131 can be closed now. I think
this is one of the last remaining instances where mkShell* uses `buildInputs`.
2024-07-14 23:14:49 +02:00
Valentin Gagarin
cdd059f7e5
fix outdated redirect (#1019) 2024-07-10 13:39:48 +00:00
Valentin Gagarin
4103098b6f
fix search link (#1018)
remove the specific channel, as search.nixos.org will deprecate old channels
2024-07-10 15:11:49 +02:00
jd1t
4c9bb5bde4
JSON convert in modules error (#1004)
* JSON convert in modules error


Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Dan Baker <daniel.n.baker@gmail.com>
2024-07-10 14:00:07 +02:00
Valentin Gagarin
6cfee511f4
fix missing changes from niv to npins (#1017)
Co-authored-by: Runningtarrens <65970993+Runningtarrens@users.noreply.github.com>
2024-07-10 11:59:12 +00:00
Anderson Torres
25593bf292 [chore] fix broken links
Because CI is not happy.
2024-06-29 03:50:16 +02:00
Anderson Torres
72a834a278 dependency-management.md: update niv references
`niv` is not exactly unmaintained - the most recent commit is from less than two
months ago. Let's rewrite this in a more neutral manner.
2024-06-29 03:50:16 +02:00
Anderson Torres
76d7323762 dependency-management.md: remove small typo referring to niv 2024-06-29 03:50:16 +02:00
Valentin Gagarin
ee7f0869c0
update Nix manuals (#1007) 2024-06-28 15:10:45 +02:00
Valentin Gagarin
27e9e6dd07
fix up wording on post-build-hook guide (#993)
- the title was misleading, because the guide is more about hooks than S3
binary caches.
- pointed Nix manual links to a fixed version
- one sentence per line
- linked the guide on configuring a binary cache
2024-06-25 10:26:08 +00:00
Valentin Gagarin
2e5d38ddb6
add top-level redirect for the Nix manual (#999) 2024-06-18 10:34:15 +02:00
jd1t
8f0c7f986a
Update working-with-local-files.md (#1001)
Use correct sources location
2024-06-17 21:51:11 +00:00
Valentin Gagarin
c2be69105c
offer the Nix manual as a single page again (#997) 2024-06-13 11:39:13 +02:00
Valentin Gagarin
6cdcc8d14f
update prose and structure for monthly reporting script (#1000)
Co-authored-by: wamirez <wamirez@protonmail.com>
2024-06-13 11:38:41 +02:00
Valentin Gagarin
78330571cf
fix grammar 2024-06-12 11:28:00 +02:00
Valentin Gagarin
fda3ce2056 fix confused linkcheck
thanks to vanity TLDs, eval.sh now gets parsed as a URL...
2024-06-11 11:39:46 +02:00
Eli Flanagan
03ece9d353
minor python-environment.md improvement (#995)
I noticed #993 mentions the one sentence per line convention. I found one line in `python-environment.md` that should follow that.
2024-06-11 11:33:07 +02:00
Valentin Gagarin
3baba1bb4e
redirect the entire mutable Nix manual URL to Hydra (#994)
also pin some unneeded links to the development version of the Nix
manual to a release

this doesn't address the full issue, because Hydra doesn't do pretty
URLs, and Netlify proxying (the 200 redirect) doesn't seem to actually
work.
2024-06-04 21:39:16 +02:00
Valentin Gagarin
143d6c0b35
add guide on post build hook (#528)
* add guide on post build hook

originally written under LGPL 2.1 for the Nix reference manual.
authors as recorded in the Nix repository:

    git log --pretty="Co-authored-by: %an <%ae>" -- doc/manual/advanced-topics/post-build-hook.xml doc/manual/src/advanced-topics/post-build-hook.md | sort | uniq

relicenced with authors' permission to CC-BY-SA 4.0: https://github.com/NixOS/nix.dev/issues/463

Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
Co-authored-by: Graham Christensen <graham@grahamc.com>
Co-authored-by: Ellie Hermaszewska <git@monoid.al>
Co-authored-by: Kevin Stock <kevin@kevinstock.org>
Co-authored-by: endgame <endgame@users.noreply.github.com>
Co-authored-by: regnat <rg@regnat.ovh>

* WIP: reword, reformat, fix links

* rebase 528 onto current master, move recipe to correct directory

* fix header case to make vale happy

* fix links after moving from nix repo

* slight rewordings for clarity

Co-authored-by: wamirez <wamirez@protonmail.com>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>

---------

Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
Co-authored-by: Graham Christensen <graham@grahamc.com>
Co-authored-by: Ellie Hermaszewska <git@monoid.al>
Co-authored-by: Kevin Stock <kevin@kevinstock.org>
Co-authored-by: endgame <endgame@users.noreply.github.com>
Co-authored-by: regnat <rg@regnat.ovh>
Co-authored-by: alex <source@proof.construction>
Co-authored-by: wamirez <wamirez@protonmail.com>
2024-06-03 23:14:18 -07:00
Valentin Gagarin
966af44eec
fix typo (#992) 2024-06-03 11:40:24 +02:00
Valentin Gagarin
bfa0c7de86
migrate from niv to npins (#991) 2024-06-03 09:50:23 +02:00
Valentin Gagarin
a792a25bb0
update contributing instructions (#987)
* update contributing instructions

running devmode with `--run` doesn't actually work, it doesn't pick up
the changes
2024-05-26 17:09:24 +02:00
Valentin Gagarin
ccc6d2dbf4 proxy development version of the Nix manual
this avoids exposing an ugly URL and allows us to move things
around later
2024-05-26 16:22:26 +02:00
Dan Baker
c682c68bde
Add first lesson for the new module tutorials. (#982)
* Add first lesson for the new module tutorials, and cut redundant parts from the deep dive


Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-05-23 08:39:28 +00:00
Pete Dietl
b14ab7bdb7 module system deep dive: minor improvements
Add more error checking to the `map.sh` and `geocode.sh` script

The default zoom of 2 results in the `center` option not showing anything
different. So, we change the default zoom to 10.

We also clear up the fact that using an option type of `nullOr <blah>` does not
set a default value of `null` for you.
2024-05-22 01:00:54 +02:00
Pete Dietl
7a26361be1 add .sh suffix to shell script files
Rename `map` to `map.sh` and `geocode` to `geocode.sh` in hopes that
when downloading, Google Chrome doesn't automatically add a `.txt` extension.
2024-05-22 01:00:54 +02:00