2022-07-14 Documentation team meeting notes #5

[fricklerhandwerk]

Nix Documentation team meeting #5

Attendees: @fricklerhandwerk @domenkozar @Mic92 @grahamc @infinisil @edolstra Quentin, Adrian, et al. from INRIA (authors of nix-tutorial.gitlabpages.inria.fr)
Notes: @fricklerhandwerk

• discussed bringing together existing material and reducing duplication with authors of INRIA’s Nix tutorials (30 min)

  • decision: will align on teaching strategy, cherry-pick from each other, and keep in touch on GitHub

• clarified how to migrate work to nix.dev (5 min)

  • @domenkozar will move nix.dev to the NixOS GitHub organization

• discussed how to establish writing standards (25 min)

  • decision: collect notes incrementally as new contributors are onboarded

• @infinisil what do we do next? write documentation, review contributions?

  • @fricklerhandwerk writing does not work as a group, reviewing should be done async
    • better decide on questions no one else can decide on, leaned towards strategy rather than minutiae
  • @domenkozar meet to learn from each other how to write good documentation, curate material and contributions

[fzakaria]

I’m honestly surprised no one (even Eelco) has taken the plunge of creating a textbook (Apress).
Going through that process would be a great forcing function to clarify and clean up a lot of documentation.

Thanks for the notes!

[fricklerhandwerk]

@fzakaria

no one (even Eelco) has taken the plunge of creating a textbook (Apress).

We can make one eventually when we have enough material, as @domenkozar noted last time.