Documentation IG - Orientation Page

Welcome! This page has links and descriptions to help you get oriented to all things Documentation for the Samvera community. Listed below are links for all our docs areas, key pages, and working spaces relevant to documentation projects. Since these outputs are somewhat spread out, this page aims to be a one-stop shop!

This page is maintained by the Documentation Interest Group. It will be reviewed annually, and sunsetted when no longer relevant.

In this page:

• Doc IG’s Project Board on GitHub: "Documentation Tasks”

  • The Doc IG maintains this board for drafting, organizing, and tracking documentation issues. See the section below: “How to use the Documentation Tasks Project Board” for an overview of working with this board.

• Slack channel: #documentation

• Google Drive: Docs IG Working document

  • working area that the Docs IG uses for brainstorming and asynchronous discussion of projects. This is our messy scratch space!

• Hyrax Documentation Framework: Information for documentation creatorsPreview

  • Outlines the overall structure for Hyrax docs, organized by intended audiences such as repo managers, content managers, developers, etc. This structure relates to the Hyrax content inventory spreadsheet below.

• Hyrax Documentation Inventory - Spreadsheet in Google Drive: Hyrax Documentation Wrangling

  • Inventory of existing user documentation, with current locations and intended audience. Refer to this for identifying gaps and planning our overall docs framework.

• Github - Hyrax project wiki: Hyrax Development Wiki

  • Located within the Hyrax repository in the Samvera github organization, this is the primary location for Developer-focused docs.

• Hyrax website. hyrax.samvera.org - note: changes are made to this in gh-pages branch of hyrax Github repo.

  • The “Getting Started” page points at

     

• Hyku Documentation Framework: Hyku DocumentationPreview

  • Provides a complete overview of Hyku’s Documentation framework. This page has detailed subpages organized by intended audiences, and links to additional contextual resources. Also has a list of Hyku Release Notes!

• Hyku Documentation Inventory - Spreadsheet in Google Drive: Hyku Documentation Wrangling

  • Inventory of existing user documentation pages for Hyku, with current locations.

• Github - Hyku project wiki: Hyku Development Wiki

  • Primary location for Developer-focused docs for Hyku; located in the Samvera github organization/Hyku repo.

• Hyku website: hyku.samvera.org - note: changes are made to this in hyku-next Github repo.

  • The “Getting Started” page points at github.com/samvera/hyku for topic: “Hyku Developers”, and the Hyku pages in Samvera Confluence for topics like: “Hyku User Documentation” , “Hyku vs. Hyrax” , “Glossary”

The main page for the Doc IG in this wiki has info on the group’s scope, meeting times & communication channels, links to meeting notes, and a list of current members. Documentation Interest GroupPreview

The Doc IG Facilitator:

• Approximately 1 hour of work per month. Can be a shared responsibility between two co-facilitators

• sends reminders for monthly meetings to Documentation channel in Slack, Samvera community email list

• preps for monthly meetings: review past agenda, set new agenda

• facilitates discussion in monthly meetings

• takes notes during monthly meetings (or requests a notetaker), and link notes into Doc IG main page

• Link to the Doc IG’s Project Board in Github: "Documentation Tasks”

The Doc IG’s Github Project Board has three primary purposes:

• anyone can create and submit a documentation request

• the Doc IG then uses this board for organizing and tracking doc requests for all Samvera projects

• Samvera community members can view the board and select a documentation request to work on

• Doc IG Project Board - Overview and How-toPreview

Notes from sprints are usually nested below Community Development Sprints parent pages, so Docs sprint notes can sometimes get buried and scattered. This list compiles links to pages from Documentation-focused sprints.

• Doc Days of Summer - Documentation Sprint DaysPreview

  • contains the schedule, participants list and assigned facilitators for Summer 2025 Doc Days

• Documentation Community Sprint Event May 2025Preview

  • This page has child pages with additional notes and other supporting docs, so it is a good starting point to check for templates and planning guidelines for running Docs Sprints.

  • In particular, this child page has wrap-up/retro notes: Wrap-up / Retro for Community Sprint May 2025 including links to lots of Docs-related github issues, and the “Hyrax Documentation Wrangling” Content Inventory Spreadsheet (which is also linked above).

Below are links to Resources that are outside of the Doc IG’s purview, but relate to documentation for Samvera or related projects.

• Presentation at Virtual Connect 2025: “Open Source Participation: A Samvera Discussion”

  • Participation Breakout: An Open Source Therapy Session and Reference DeskPreview

  • This presentation provides an orientation to the Samvera community, and an overview for how to get started with participating in Samvera projects. The video gives a tour of where to find information about participating in development and testing, documentation, and how interest groups and working groups fit into all of this in our community. Download the slides for accessing links mentioned in this presentation from:“Participation Breakout: An Open Source Therapy Session and Reference Desk”, in the Samvera Virtual Connect 2025 AgendaPreview page in this wiki.