Updates in leu of SIG: Documentation meetings on 2024-07-27, 2024-08-03

Special Interest Groups SIG Documentation
1

Hello! Due to low attendance (only @minion and @8bitbuddhist) at today’s meeting, we’ve decided to cancel it and replace it with an async update post. Here were the agenda items, please give an update to your pieces in this post

So we can construct a good agenda for next time, please also say what you’d like to work on next week. It could be the same thing, but it doesn’t have to be

Additionally, @minion and @coded are away next week. If you’d like to discuss what to do about next week’s meeting, please join the SIG: Documentation General room on matrix. Once a consensus has been reached, I’ll summarize for the group in this post.

Thanks very much, everyone, and I’ll see you in 2 weeks’ time :wave:

1 Like
2

Up in the air whether I’ll be able to make it, we’ll see. If not, my notes of what happened are listed in matrix, but tl;dr: More lix admonitions fixed, as well as adding a first draft of NixOS options docs. If I make it I’ll provide more details.

2 Likes
3

My updates:

  • Buildbot is up :tada:
    • you can access it at https://builds.auxolotl.org
    • it will build any repository that the buildbot user has access to. Project refresh happens 2 times per day, so if it doesn’t build your thing yet you should wait a little bit
    • it’s buildbot-nix, so it will build checks
    • right now it has a very underpowered machine behind it … please don’t build things that are too heavy on it (more on this later)
  • Forgejo is up-to-date
  • Forgejo pages
    • I have not put a pages server up yet … I wonder about if it would be more sensible to take buildbot outputs and host them using nginx rather than host something extra, given we don’t need it to be generic to any repository, only a select few

Over the next week I will be:

  • Getting a buildbot worker on a more powerful machine to enable building “silly little things like the nixos manual”
  • Looking into hosting a website from buildbot outputs via nginx
3 Likes
4

This weeks updates

  1. Release clarifications for contributing/formatting/tools.md
  2. update to contributing/formatting/editorconfig.md to remove insert_final_newline = false
  3. added treefmt to the flake, thanks @minion for support:

What I’ll be working on in the next week

  • [TODO] look through other aux repos that have editorconfig and correct if their formatting deviates from the updates in 1.
  • [TODO] removed all references to github groups in onboarding
  • [TODO] updated contributing/formatting/tools.md - add treefmt instructions

Question
Is treefmt-nix the way to go for auxolotl or do we wanna make it “the way”? If yes, do the following tasks make sense?

  • [TODO] add treefmt-nix to other repos that already use formatters
  • [TODO] adjust template to include updated editorconfig
2 Likes
5

Apologies for being inactive lately. I’m going on vacation this week! I’ve got the wiki updates for the system template ready to go. It’s been a little bit since I last ran the template, so I’m going to re-test it and see if any updates are needed, in case there were changes to nixpkgs in the meantime

2 Likes