diff --git a/maintainers/README.md b/maintainers/README.md index 23d5fae..a7de169 100644 --- a/maintainers/README.md +++ b/maintainers/README.md @@ -10,40 +10,68 @@ The Nix documentation team was formed to flatten the infamous learning curve. ## Motivation -To finally improve the state of affairs with Nix onboarding and documentation, we have to tackle some big issues and work through many small ones: implement structural changes after gathering the necessary social support; fix numerous little problems and help people get their contributions merged. +To improve the state of affairs with Nix onboarding and documentation, we have to tackle some big issues and work through many small ones: +implement structural changes after gathering the necessary social support; +fix numerous little problems and help people get their contributions merged. -It appears that, so far, no one really had the time or resources required to do this consistently. The team is built around that limitation, and therefore organized as a praxicracy: you are in charge if and only if you get the work done. The team’s reason to exist is to make that principle discoverable and reproducible by laying groundwork and setting examples. +It requires significant time or resources to do this consistently. +The team is built around that limitation, and therefore organized as a praxicracy: +you are in charge if and only if you get the work done. + +The team’s reason to exist is to make that principle discoverable and reproducible by laying groundwork and setting examples. ## Members -- Valentin Gagarin (@fricklerhandwerk) (lead until 2022-10-31) +- Luc Perkins ([@lucperkins]) (lead until 2023-01-31) - Nix documentarian, [Tweag](tweag.io) + Nix Advocate, [Determinate Systems] -- Domen Kožar (@domenkozar) +- Valentin Gagarin ([@fricklerhandwerk]) - [nix.dev](http://nix.dev) author, [Cachix](cachix.org) + Nix documentarian, [Tweag] -- Jörg Thalheim (@Mic92) +- Domen Kožar ([@domenkozar]) - NixOS Wiki maintainer + [nix.dev](http://nix.dev) author, [Cachix](https://cachix.org) -- Silvan Mosberger (@infinisil) +- Jörg Thalheim ([@Mic92]) - `nixpkgs` maintainer, [Tweag](tweag.io) + NixOS Wiki maintainer + +- Silvan Mosberger ([@infinisil]) + + Nixpkgs maintainer, [Tweag] + +[@lucperkins]: https://github.com/lucperkins +[@fricklerhandwerk]: https://github.com/fricklerhandwerk +[@domenkozar]: https://github.com/domenkozar +[@Mic92]: https://github.com/Mic92 +[@infinisil]: https://github.com/infinisil + +[Determinate Systems]: https://determinate.systems +[Tweag]: https://tweag.io ## Responsibilities ### Team Ordered by priority: -- establish and maintain guidelines for contributing to documentation -- extend and curate [nix.dev](https://nix.dev) as the central learning resource – long-term vision: The Nix Book -- review and merge [Nix pull requests](https://github.com/NixOS/nix/pulls?q=is%3Aopen+is%3Apr+label%3Adocumentation) and [Nixpkgs and NixOS pull requests](https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+is%3Apr+label%3A%228.has%3A+documentation%22) concerning documentation -- keep track of [Nix issues](https://github.com/NixOS/nix/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation) and [`nixpkgs` and NixOS issues](https://github.com/NixOS/nixpkgs/issues?q=is%3Aopen+is%3Aissue+label%3A%229.needs%3A+documentation%22) concerning documentation -- monitor the [Documentation Discouse category](https://discourse.nixos.org/c/dev/documentation/25) -- monitor the [Nix* Documentation Matrix room](https://app.element.io/#/room/#docs:nixos.org) -- monitor [changes to the NixOS Wiki](https://matrix.to/#/#nixos-wiki:utzutzutz.net) +1. establish and maintain guidelines for contributing to documentation +1. extend and curate [nix.dev] as the central learning resource – long-term vision: The Nix Book +1. review and merge [Nix pull requests] and [Nixpkgs and NixOS pull requests] concerning documentation +1. keep track of [Nix issues] and [Nixpkgs and NixOS issues] concerning documentation +1. monitor the [Documentation Discourse category] +1. monitor the [Nix\* Documentation Matrix room] +1. monitor [changes to the NixOS Wiki] + +[nix.dev]: https://nix.dev +[Nix pull requests]: https://github.com/NixOS/nix/pulls?q=is%3Aopen+is%3Apr+label%3Adocumentation +[Nixpkgs and NixOS pull requests]: https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+is%3Apr+label%3A%228.has%3A+documentation%22 +[Nix issues]: https://github.com/NixOS/nix/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation +[Nixpkgs and NixOS issues]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aopen+is%3Aissue+label%3A%229.needs%3A+documentation%22 +[*Documentation* Discourse category]: https://discourse.nixos.org/c/dev/documentation/25 +[*Nix\* Documentation* Matrix room]: https://app.element.io/#/room/#docs:nixos.org +[changes to the NixOS Wiki]: https://matrix.to/#/#nixos-wiki:utzutzutz.net ### Team lead @@ -59,7 +87,7 @@ Ordered by priority: ## Meeting protocol -The team holds bi-weekly meetings on Thursdays 17:30-18:30 (Europe/Berlin): +The team holds meetings every second Thursday 17:30-18:30 (Europe/Berlin): - [NixOS calendar](https://calendar.google.com/calendar/u/0/embed?src=b9o52fobqjak8oq8lfkhg3t0qg@group.calendar.google.com) - [Discourse community calendar](https://discourse.nixos.org/t/community-calendar/18589) @@ -68,20 +96,23 @@ The purpose of the meetings is to - coordinate efforts - exchange experience and insights. -As the Nix community is distributed globally, available time for synchronous communication is highly limited and therefore very valuable. Writing is still the primary medium of communication. +As the Nix community is distributed globally, available time for synchronous communication is highly limited and therefore very valuable. +Writing is still the primary medium of communication. To keep discussions highly focused and make their results accessible, we will: -- prepare meeting agendas as a pull requests on the [nix.dev repository](https://github.com/NixOS/nix.dev) +- prepare meeting agendas as pull requests on the [nix.dev repository](https://github.com/NixOS/nix.dev) - pull requests have priority, invite authors to the meetings - annotate estimated discussion time for each agenda item, it should be followed -- prepare notes collaboratively, e.g. in a [HackMD](https://hackmd.io/) scratchpad +- prepare notes collaboratively in a [HedgeDoc scratchpad] - merge pull requests made on the last session - submit new pull requests or issues - add notes to existing issues or pull requests as a comment -- post the meeting protocol on the [Discourse documentation category](https://discourse.nixos.org/c/dev/documentation/25) +- post the meeting protocol on the [*Documentation* Discourse category] - update calendar invitations +[HedgeDoc scratchpad]: https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA?edit# + Meeting notes should contain: - date of meeting @@ -94,6 +125,9 @@ If you want to help immediately, please see [How to contribute to documentation] ## Funding -This effort is sponsored by [Tweag](tweag.io). -@fricklerhandwerk will dedicate at least 15h/w from 2022-10 until at least 2022-10 towards improving Nix documentation. +This effort is sponsored by [Determinate Systems]. +[@lucperkins] will serve as the team lead until 2023-01. + +This effort was sponsored by [Tweag]. +[@fricklerhandwerk] served as the team lead from 2022-05 to 2022-10.