This Month in Nix Docs - #1 - March 2023
Community
You can always find the Documentation Team on Matrix: Nix Documentation. Drop in if you’d like to contribute!
Call for Maintainers
There was a call for maintainers at the beginning of the month that kicked off a revitalization of the team. As part of that process I joined the team along with several other people. You can see the official list here, but I can tell you right now not everyone who contributes is on that list. Thanks to everyone who has chipped in over the last month! If you’d like to get involved you can reach us on Matrix or by opening an issue on NixOS/nix.dev.
Projects
Applying to Google Season of Docs 2023
This month we spent time putting together a proposal for Google Season of Docs, which provides funding for documentation-related projects in open source software. The announcement post lists all of the people involved in this process. Thank you to everyone that worked on this!
PRs:
- #489 refine justification for the budget (@fricklerhandwerk)
- #482 re-scope the Google Season of Docs project (@fricklerhandwerk)
- #471 add draft for Google Season of Docs project proposal (@fricklerhandwerk)
Formation of the Learning Journey Working Group
Another major undertaking was the formation of a Learning Journey Working Group under the Documentation Team with me (@zmitchell) as the lead. That happened here:
- #468 Establish Learning Journey Working Group (@zmitchell)
The stated goal of the working group is to figure out how to teach Nix and to determine the content and structure of the documentation that will enable us to do so. Our first project is a set of tutorials that takes new users from first contact with Nix to minimally competent. You can follow that here:
- #499 Tracking issue - re-shape current content into a structure based on Diataxis
- #498 Tracking issue - learning journey - nix-shell tutorial
Project Management
Organizing work from people all over the world who volunteer in their off-hours is tough! I’ve proposed that we follow some lightweight project management to keep track of who’s doing what, the status of various projects, etc. You can follow that progress here:
- #493 Tracking issue - project management infrastructure
The goal is to make it immediately obvious what our current projects are, which steps are required to get to “done”, and which steps are remaining.
RFCs
New
Documentation PRs Merged
NixOS/nix
- #8133 Extend internal API docs, part 2 (@Ericson2314)
-
#8123 Docs: Explain why
import nixpkgsworks in flakes (@nomeata) - #8114 Fix more profile dirs in docs (@Ericson2314)
- #8084 Auto-generate store documentation (@edolstra)
- #8083 Fix misrendering of ‘nix store --help’ (@edolstra)
-
#8078 Fix
nix profile --help(@Ericson2314) - #8070 docs: quote URL literals (@figsoda)
-
#7975 remove indentation in
fetchGitattribute listing (@fricklerhandwerk) - #7968 Add CONTRIBUTING.md (@bobvanderlinden)
-
#7928 Documentation: process
#includedirectives (@balsoft) - #7896 Generate API docs with Doxygen (@Ericson2314)
-
#7854 Document
hasAllInfo(@aameen-tulip) - #7605 add comments (@Radvendii)
-
#7518 separate man pages for
nix-storeandnix-envsubcommands (@fricklerhandwerk) - #7486 reword definition of “reference” (@fricklerhandwerk)
-
#7406 Document
gitlabinput scheme (@amesgen) - #7376 clarify definition of “installable” (@fricklerhandwerk)
- #6338 add labeler workflow (@Artturin)
NixOS/nixpkgs
NixOS/nix-pills
- #210 Pill 20: allow wrapped hello to be executed (@mistydemeo)
- #209 Pill 17: fix asciidoc-full name (@mistydemeo)
- #208 Pill 17: fix graphviz xorg override (@mistydemeo)
- #207 Pill 8: fix Darwin reference to binutils (@mistydemeo)
- #205 Use HTTPS links in 8th pill (@CyrusYip)
NixOS/nix.dev
- #489 refine justification for the budget (@fricklerhandwerk)
- #486 remove CLA (@asymmetric)
- #482 re-scope the Google Season of Docs project (@fricklerhandwerk)
- #476 Add myself as a code owner for Learning Journey WG docs (@zmitchell)
- #474 Add myself (pstn) as member. (@pstn)
- #473 Add myself to Learning Journey WG (@asymmetric)
- #472 reword introduction to shebangs (@fricklerhandwerk)
- #471 add draft for Google Season of Docs project proposal (@fricklerhandwerk)
- #469 documentation team: add Henrik (@henrik-ch)
- #468 Establish Learning Journey Working Group (@zmitchell)
- #467 Fix Typo (@breezeight)
- #466 documentation team: add @pennae and @olafklingt (@fricklerhandwerk)
- #462 Quote URLs in nix language tutorial (@munyari)
- #459 limit depth of tutorials TOC (@fricklerhandwerk)
- #455 chore(deps): bump cachix/install-nix-action from 19 to 20 (@app/dependabot)
- #447 rework nix-shell tutorial (@fricklerhandwerk)
- #446 add additional links and next steps (@fricklerhandwerk)
- #432 remove redundant terms from glossary (@fricklerhandwerk)
- #409 Remove information overload from toctrees (@yukiisbored)
- #399 Add information about installing nix by pacman (@Freed-Wu)
- #334 tutorial: nixos configurations on vm (@olafklingt)
- #311 add guide to writing tutorials (@fricklerhandwerk)
- #265 add outline to contribution guide (@fricklerhandwerk)
