2025-03-18 Documentation Interest Group meeting notes

Zoom link

 Participants

• @Kiah Stroud

• @Nic Don Stanton-Roark

• @Morgan McKeehan

• @Christine Peterson

• Sarah Proctor

• Dona

• @Benjamin Riesenberg

 Goals

• Discuss documentation needs

• Discuss documentation sprint strategy for Virtual Connect

• Categorize tasks on the issue board

 Discussion notes

• Any documentation needs from participants?

  • Nic: would like to add non-technical release notes for Hyku

    • Where would it be best to put these?

    • An example from another open-source project

      • Technical: Release BookStack v25.02 · BookStackApp/BookStack

      • Non-technical: https://www.bookstackapp.com/blog/bookstack-release-v25-02/

    • Desired implementation timeline: middle of 2025 (Hyku v6.2)

• Clarifications around the responsibilities of this group’s members

  • What is our primary goal?

    • Simply reporting documentation needs

    • If you would like to complete a documentation-related task or champion its completion, you are more than welcome to, but you would be doing so as a community member, not because it’s an expectation of this group

• Using templates

  • It would reduce friction if we had a template for the community to use to capture a documentation task

  • It would reduce friction to have a template for community members to be able to use to create new documentation

  • GitHub templates are only possible on full Issues, which, unlike Drafts, are required to be linked to a specific repository

    • Consider creating a documentation Samvera repo in the future to house these templates

• Documentation sprint strategy for Virtual Connect

  • Ensure the GitHub board is up to date

    • Review existing tickets to make sure they’re still relevant

    • Add new tickets

    • Create board views for folks looking to complete technical or non-technical documentation tasks specifically

 Action items

Prep for the Virtual Connect documentation sprint:

 Decisions

1. Create a new column on the GitHub board called “Ready”
2. Create a new tag on the board to specify who can complete the ticket based on their role (“developer”, “user”, etc)