Skip to content

Commit 8fb30c0

Browse files
Merge branch 'master' into update-frontpage
2 parents 416d793 + 11f9ab4 commit 8fb30c0

File tree

12 files changed

+69
-97
lines changed

12 files changed

+69
-97
lines changed

README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
<img alt="CI"
2-
src="https://github.com/nix-dot-dev/nix.dev/workflows/CI/badge.svg">
1+
[![](https://github.com/NixOS/nix.dev/actions/workflows/build-and-deploy.yml/badge.svg)](https://github.com/NixOS/nix.dev/actions)
32

43
# [nix.dev](https://nix.dev)
54

_redirects

+4
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,12 @@
3232
/tutorials/file-sets /tutorials/working-with-local-files 301
3333
/tutorials/module-system/module-system /tutorials/module-system/deep-dive 301
3434

35+
/acknowledgments /acknowledgements 301
36+
/acknowledgments/sponsors /acknowledgements 301
37+
3538
/permalink/stub-ld /guides/faq#how-to-run-non-nix-executables 301
3639
/manual/nix /reference/nix-manual 200
3740
/manual/nix/unstable/* https://hydra.nixos.org/job/nix/master/manual/latest/download/1/manual/:splat 200
3841
/manual/nix/development/* https://hydra.nixos.org/job/nix/master/manual/latest/download/1/manual/:splat 200
3942
/tutorials/nixos/continuous-integration-github-actions /guides/recipes/continuous-integration-github-actions 301
43+

maintainers/README.md

+3-38
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ In addition to the team members' responsibilities, a team lead is expected to:
7575
- Manage permissions for the [GitHub team] and the [GitHub project board]
7676
- Update [NixOS calendar] events
7777
- Merge pull requests approved by team members
78-
- Manage [the team's Open Collective page][documentation team on Open Collective]
78+
- Manage [the team's Open Collective page]
7979

8080
[GitHub team]: https://github.com/orgs/NixOS/teams/documentation-team
8181
[GitHub project board]: https://github.com/orgs/NixOS/projects/15
@@ -126,42 +126,7 @@ Meeting notes should contain:
126126

127127
If you want to help immediately, please see [How to contribute to documentation](https://nix.dev/contributing/documentation).
128128

129-
If you don't have time, consider donating to [documentation team on Open Collective].
129+
If you don't have time, consider donating to [documentation team on Open Collective][the team's Open Collective page].
130130

131-
## Sponsoring
132-
133-
- [@fricklerhandwerk] serves as the team lead since 2023-02, sponsored by [Antithesis](https://antithesis.com)
134-
- [@zmitchell] led the Learning Journey Working Group from 2023-03 to 2023-08, sponsored by [flox](https://floxdev.com)
135-
- [@infinisil] worked on the team between 2022-11 and 2024-05, sponsored by [Tweag]
136-
- [@lucperkins](https://github.com/lucperkins) served as the team lead from 2022-11 to 2023-01, sponsored by [Determinate Systems](https://determinate.systems)
137-
- [@fricklerhandwerk] served as the team lead from 2022-05 to 2022-10, sponsored by [Tweag]
138-
139-
[@fricklerhandwerk]: https://github.com/fricklerhandwerk
140-
[@zmitchell]: https://github.com/zmitchell
141-
[Tweag]: https://tweag.io
142-
[@infinisil]: https://github.com/infinisil
143-
144-
## History
145-
146-
Many thanks to past members, who helped make Nix documentation what it is today:
147-
148-
- [@infinisil] helped lead the team between 2022-11 and 2024-05.
149-
During that time he provided diligent technical reviews of countless contributions, reworked the [contribution guides for Nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md), and rewrote his [module system tutorial](https://nix.dev/tutorials/module-system/deep-dive) for publication.
150-
151-
- [@olafklingt](https://github.com/olafklingt) volunteered on the team from 2022-10 to 2024-05, and was a formal member between 2022-10 and 2024-05.
152-
He added an [introduction to NixOS virtual machines](https://nix.dev/tutorials/nixos/nixos-configuration-on-vm) and greatly simplified the [tutorial on NixOS VM tests](https://nix.dev/tutorials/nixos/integration-testing-using-virtual-machines), and kept them up to date.
153-
Both articles enjoy great popularity and are central elements of our tutorial series.
154-
155-
- [@brianmcgee](https://github.com/brianmcgee) was part of the team from 2023-03 to 2023-10 and contributed to the Learning Journey Working Group effort.
156-
157-
- [@zmitchell] led the [Learning Journey Working Group](https://discourse.nixos.org/search?q=learning%20journey%20working%20group%20-%20meeting%20notes%20in%3Atitle%20order%3Alatest_topic) from 2023-03 to 2023-08 that added a number of tutorials.
158-
He published [regular updates on developments in documentation](https://discourse.nixos.org/search?q=This%20Month%20in%20Nix%20Docs%20in%3Atitle%20before%3A2023-10-30%20order%3Alatest_topic) in that period.
159-
160-
- [@Mic92](https://github.com/Mic92) was a founding member and part of the team from 2022-05 to 2023-01.
161-
Jörg had written a great deal of documentation on the NixOS Wiki, and shared his experience to set a direction for the documentation team.
162-
163-
- [@domenkozar](https://github.com/domenkozar) was a founding member and part of the team from 2022-05 to 2023-01.
164-
Domen originally started nix.dev, wrote many basic tutorials, and funded editorial work through [Cachix](https://www.cachix.org/).
165-
He helped bootstrap the documentation team, handed out permissions, and advised us on many aspects.
166-
Domen donated nix.dev to the NixOS Foundation 2023-07.
131+
[the team' Open Collective page]: https://opencollective.com/nixos/projects/nix-documentation
167132

source/acknowledgements/index.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
(acknowledgements)=
2+
# Acknowledgements
3+
4+
## Sponsoring
5+
6+
The following people and organisations have contributed to make this effort possible:
7+
8+
- [@fricklerhandwerk] serves as the team lead since 2023-02, sponsored by [Antithesis](https://antithesis.com) from 2023-02 to 2024-04
9+
- [@zmitchell] led the Learning Journey Working Group from 2023-03 to 2023-08, sponsored by [flox](https://floxdev.com)
10+
- [@infinisil] worked on the team between 2022-11 and 2024-05, sponsored by [Tweag]
11+
- [@lucperkins](https://github.com/lucperkins) served as the team lead from 2022-11 to 2023-01, sponsored by [Determinate Systems](https://determinate.systems)
12+
- [@fricklerhandwerk] served as the team lead from 2022-05 to 2022-10, sponsored by [Tweag]
13+
14+
[@fricklerhandwerk]: https://github.com/fricklerhandwerk
15+
[@zmitchell]: https://github.com/zmitchell
16+
[Tweag]: https://tweag.io
17+
[@infinisil]: https://github.com/infinisil
18+
19+
## History
20+
21+
Many thanks to past contributors, who helped make Nix documentation what it is today:
22+
23+
- [@infinisil] helped lead the team between 2022-11 and 2024-05.
24+
During that time he provided diligent technical reviews of countless contributions, reworked the [contribution guides for Nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md), and rewrote his [module system tutorial](https://nix.dev/tutorials/module-system/deep-dive) for publication.
25+
26+
- [@olafklingt](https://github.com/olafklingt) volunteered on the team from 2022-10 to 2024-05, and was a formal member between 2022-10 and 2024-05.
27+
He added an [introduction to NixOS virtual machines](https://nix.dev/tutorials/nixos/nixos-configuration-on-vm) and greatly simplified the [tutorial on NixOS VM tests](https://nix.dev/tutorials/nixos/integration-testing-using-virtual-machines), and kept them up to date.
28+
Both articles enjoy great popularity and are central elements of our tutorial series.
29+
30+
- [@brianmcgee](https://github.com/brianmcgee) was part of the team from 2023-03 to 2023-10 and contributed to the Learning Journey Working Group effort.
31+
32+
- [@zmitchell] led the [Learning Journey Working Group](https://discourse.nixos.org/search?q=learning%20journey%20working%20group%20-%20meeting%20notes%20in%3Atitle%20order%3Alatest_topic) from 2023-03 to 2023-08 that added a number of tutorials.
33+
He published [regular updates on developments in documentation](https://discourse.nixos.org/search?q=This%20Month%20in%20Nix%20Docs%20in%3Atitle%20before%3A2023-10-30%20order%3Alatest_topic) in that period.
34+
35+
- [@Mic92](https://github.com/Mic92) was a founding member and part of the team from 2022-05 to 2023-01.
36+
Jörg had written a great deal of documentation on the NixOS Wiki, and shared his experience to set a direction for the documentation team.
37+
38+
- [@domenkozar](https://github.com/domenkozar) was a founding member and part of the team from 2022-05 to 2023-01.
39+
Domen originally started nix.dev, wrote many basic tutorials, and funded editorial work through [Cachix](https://www.cachix.org/).
40+
He helped bootstrap the documentation team, handed out permissions, and advised us on many aspects.
41+
Domen donated nix.dev to the NixOS Foundation 2023-07.

source/acknowledgments/index.md

-9
This file was deleted.

source/acknowledgments/sponsors.md

-8
This file was deleted.

source/contributing/how-to-contribute.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22
# How to contribute
33

44
The Nix ecosystem is developed by many volunteers and a few paid developers, maintaining one of the largest open source software distributions in the world.
5-
Keeping it working and up to date – and improving it continuously – would not be possible without your support.
5+
Keeping it working and up to date – and improving it continuously – would not be possible without your support!
66

77
This guide shows how you can contribute to {term}`Nix`, {term}`Nixpkgs` or {term}`NixOS`.
8+
It assumes that you're already somewhat proficient with basic concepts and workflows, which are outlined in the [beginner tutorial series](tutorials).
9+
The most important aspects are [the Nix language](reading-nix-language), the various Nixpkgs mechanisms for [constructing derivations to build software](packaging-tutorial)</a>, [the module system](module-system-tutorial), and [NixOS integration tests](integration-testing-vms).
810

911
:::{important}
1012
If you cannot contribute time, consider [donating to the NixOS Foundation on Open Collective](https://opencollective.com/nixos).
1113

12-
Currently the focus is on funding in-person events to share knowledge and grow the community of developers proficient with Nix.
14+
Currently the focus is on [funding in-person events](https://github.com/NixOS/foundation/issues?q=is%3Aissue%20label%3Afunding-request%20) to share knowledge and grow the community of developers proficient with Nix.
1315
With enough budget, it would be possible to pay for ongoing maintenance and development of critical infrastructure and code – demanding work that we cannot expect to be done by volunteers indefinitely.
1416
:::
1517

1618
## Getting started
1719

18-
Start with asking informed questions, after reading reference documentation and the code relevant to what you care about.
20+
Start with asking informed questions, after reading [reference documentation](reference) and the code relevant to what you care about.
1921

2022
[Join our community communication platforms](https://nixos.org/community) to get in contact with other users and developers.
2123
Check out and consider participating in our [community teams](https://nixos.org/community/#governance-teams) if you're interested in a particular topic.
@@ -89,6 +91,10 @@ If you want to help with development, check the [contributing guide in the Nix r
8991
(contribute-nixpkgs)=
9092
## Contribute to Nixpkgs
9193

94+
:::{tip}
95+
For a verbal introduction, watch the NixCon 2024 talk [Becoming a Nixpkgs Contributor](https://www.youtube.com/watch?v=eijTOBBbCv4).
96+
:::
97+
9298
{term}`Nixpkgs` is a large software project with various areas of development.
9399
You can find inspiration for things to improve in the [Nixpkgs issue tracker][nixpkgs issues].
94100

@@ -111,3 +117,6 @@ If you know your way around, working on [popular issues][nixos issues] will be h
111117

112118
[nixos issues]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aopen+is%3Aissue+label%3A%226.topic%3A+nixos%22+sort%3Areactions-%2B1-desc
113119

120+
# How to get help
121+
122+
If you prepared a pull request and need help moving forward, check [](contributing-how-to-get-help) for

source/contributing/how-to-get-help.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(contributing-how-to-get-help)=
12
# How to get help
23

34
If you need assistance with one of your contributions, there are a few places you
@@ -20,9 +21,9 @@ For better efficiency and higher chance of success, you should try contacting in
2021

2122
## Which communication channels to use
2223

23-
Once you've found the people you're looking for, you can contact them on one of the following platforms:
24+
Once you've found the people you're looking for, you can contact them on one of the [community communication platforms](https://nixos.org/community):
2425

25-
- GitHub
26+
- [GitHub](https://github.com/nixos)
2627

2728
All the source code is maintained on GitHub.
2829
This is the right place to discuss implementation details.
@@ -51,7 +52,7 @@ Once you've found the people you're looking for, you can contact them on one of
5152

5253
- Meetings and events
5354

54-
Check the [Discourse community calendar](https://discourse.nixos.org/t/community-calendar/18589) for real-time or in-person events.
55+
Check the [official NixOS Calendar](https://calendar.google.com/calendar/u/0/[email protected]) and the [Discourse community calendar](https://discourse.nixos.org/t/community-calendar/18589) for real-time or in-person events.
5556
Some community teams hold regular meetings and publish their meeting notes.
5657

5758
## Other venues

source/guides/recipes/continuous-integration-github-actions.md

-30
Original file line numberDiff line numberDiff line change
@@ -72,40 +72,10 @@ jobs:
7272
Once you commit and push to your GitHub repository,
7373
you should see status checks appearing on commits and PRs.
7474
75-
## Caching builds using GitHub Actions Cache
76-
77-
A quick and easy way to speed up CI on any GitHub repository is to use the [Magic Nix Cache][magic-nix-cache].
78-
The Magic Nix Cache doesn't require any configuration, secrets, or credentials.
79-
This means the caching benefits automatically work for anyone who forks the repository.
80-
81-
One downside to the Magic Nix Cache is it only works inside GitHub Actions.
82-
For more details, check out [the readme][magic-nix-cache] and the [limits of GitHub Actions caching][github-actions-caching-limits].
83-
84-
Create `.github/workflows/test.yml` with:
85-
86-
```yaml
87-
name: "Test"
88-
on:
89-
pull_request:
90-
push:
91-
jobs:
92-
tests:
93-
runs-on: ubuntu-latest
94-
steps:
95-
- uses: actions/checkout@v4
96-
- uses: cachix/install-nix-action@v25
97-
with:
98-
nix_path: nixpkgs=channel:nixos-unstable
99-
- uses: DeterminateSystems/magic-nix-cache-action@v2
100-
- run: nix-build
101-
- run: nix-shell --run "echo OK"
102-
```
103-
10475
## Next steps
10576
10677
- See [GitHub Actions workflow syntax](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions)
10778
- To quickly setup a Nix project read through
10879
[Getting started Nix template](https://github.com/nix-dot-dev/getting-started-nix-template).
10980
110-
[magic-nix-cache]: https://github.com/DeterminateSystems/magic-nix-cache-action/
11181
[github-actions-caching-limits]: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows

source/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,5 +110,5 @@ guides/index.md
110110
reference/index.md
111111
concepts/index.md
112112
contributing/index.md
113-
acknowledgments/index.md
113+
acknowledgements/index.md
114114
```

source/tutorials/nix-language.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1111,7 +1111,7 @@ Each of them is explained in the following, and here is an overview:
11111111
{ a, b, ... }@args: a + b + args.c
11121112
```
11131113

1114-
Functions have no names.
1114+
Functions in the Nix language have no names.
11151115
We say they are anonymous, and call such a function a *lambda*.[^lambda]
11161116

11171117
[^lambda]: The term *lambda* is a shorthand for [lambda abstraction](https://en.wikipedia.org/wiki/Lambda_calculus#lambdaAbstr) in the [lambda calculus](https://en.wikipedia.org/wiki/Lambda_calculus).

source/tutorials/nixos/building-and-running-docker-images.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ pkgs.dockerTools.buildImage {
3939
:::{note}
4040
If you're running **macOS** or any platform other than `x86_64-linux`, you'll need to either:
4141

42-
- [Set up a remote builder](distributed-build-setup-tutorial) to build on Linux
43-
- {ref}`Cross compile to Linux <cross-compilation>` by replacing `pkgsLinux.hello` with `pkgs.pkgsCross.musl64.hello`
42+
- [Set up a remote build machine](distributed-build-setup-tutorial) to build on Linux
43+
- [Cross compile to Linux](cross-compilation) by replacing `pkgsLinux.hello` with `pkgs.pkgsCross.musl64.hello`
4444
:::
4545

4646
We call the `dockerTools.buildImage` and pass in some parameters:

0 commit comments

Comments
 (0)