Minutes from SIG: Documentation on 2024-08-17

SIG: Documentation meeting on 2024-08-17

Attendees:

Agenda

  • Approval/Revision of Agenda
    • @dfh: should we discuss emails?
      • @minion: I think we should wait on the announcement until we have receiving emails working … but let’s still add email to the agenda though :slight_smile:
  • @minion: buildbot
    • @minion: Buildbot up and working, executes ‘flake checks’ to check automatically
    • @minion: downsides Cache missing, only 1 worker that also handles forgejo, possibly more workers from tc424
      • @dfh: Can we have a set of criteria and modules that implement a secure worker? Possibly have some checkmarks of what makes a trustable community member.
        • @minion: Good idea, but dont let theoretical/ trust aspects block having workers available.
        • @dfh: Possibly ask Jake for guidance on trust.
        • @dfh: We currently don’t have any critical packages we build, this might leave us with more space for technical experimentation right now. With the goal to see/ prove that it’s technically feasible.
    • @minion: network access hidden behind a headscale instance
    • @minion: Looking at hosting websites from the builder, like pyroxs docs-site
    • @dfh: Do we have forgejo workers then?
      • @minion: No, buildbox links as a bot account into PRs, is not triggered by forgejo CI functions
  • @pyrox: This week in https://docs.auxolotl.org
  • @dfh: .editorconfigs and treefmt
    • @dfh: With @minions help sorted it out.
    • @dfh: Is docs authoritative on style and formatting, can we send PRs to other teams to fix their repos?
    • @dfh: Should we do direnv + devshells per default for all flakes?
      • @minion: Yes. Make sure to exclude ‘.direnv’ and various other git related files.
      • @dfh: I’ll add direnv + devshell to my TODO list
  • @dfh, @minion: email
    • @minion: Mail is not yet routed to the new server due to MX priorities + mailgun not excepting incoming emails
      • @minion: Does the forum use email replies?
        • @dfh: We can test by sending a DM + trying to reply to email notification
    • @dfh: Only mail, no calendar or contacts for now, can do jmap though
    • @dfh: No webmail right now, but I’m thinking about roundcube{,-jmap}. they now have commercial backing by nextcloud. One can possibly use the gmail IMAP import as frontend too (still to be tested).
  • @dfh git workflow examples to do PRs w/ forgejo properly
    • @dfh Maybe something that points to a nicer/ easier tool(s). Oriented along the regular tasks: Create a PR, Add to your own PR, add to someone elses PR
    • @minion: What’s the audience? “GH Desktop users”?
      • @dfh: What if we describe the scenarios per tool, like we do for modules/ flakes?
        • @minion: Yes. Possible tools jj, gh desktop, git native
        • @minion & @dfh Will figure out a date & time in October to get started

Action Items

  • @minion + @dfh: Look at headscale networking issue
  • @dfh: Send PRs for .editorconfig + treefmt to other aux repos + templates
  • @dfh: Add treefmt instructions to wiki
  • @dfh: Add direnv + devshell to docs repo
  • @minion: Work out MX priorities with Jake
  • @dfh + @minion: Figure out date & time to get started on git workflow docs

Standing reminders

  • Next meeting will be at the same time next week!
2 Likes

I’ve had some other jobs to do but I’m getting to the point where I can look at this again! We’re nearly there - the headscale / tailscale link is working, at least :)

2 Likes