Samvera Community Wiki
Documentation Notes: Wrap-up / Retro for Community Sprint May 2025
Group updates
Review action items from yesterday
updates to Content Inventory are underway -->for
Create an inventory of existing user documentation (Hyrax) · Issue #7101 · samvera/hyrax
Check in on Project board
Review of Board:
We started the Docs Spring with 14 tasks in Done, now at 18. Also lots of activity generally, various issues added and things in progress.
check-in on Features Guide ticket - currently in Questions/Blockers column: https://github.com/samvera/hyrax/issues/7096.
For this ticket, the Feature Matrix is ready for review & feedback:
Feature matrix Decision: folks can take a look at the Matrix, add any comments/Qs into ticket. If after a few days there’s no big challenges identified, this can get moved to Done.
Other in-progress:
- Technology Stack page needs to be updated with Valkyrie information · Issue #968 · samvera/valkyrie
- Create an inventory of existing user documentation (Hyku) · Issue #2566 · samvera/hyku
this inventory sheet has been modeled on the Hyrax sheet, & is starting from Github repo. Currently looking at other source locations that will be included in the inventory.
and Hyrax #7101 mentioned above.
RE: 7101, Folks should take a look at the Content Inventory, see if there are other locations or info types that should be included?
Q: access to Hyrax drive? Similarly for Hyku drive - may need to confirm that those who are working on the Doc inventories, have the access they need to these drives?
Docdays of Summer! Interested in leading a Documentation Day in the Samvera Community? Contact Heather Greer Klein (heather@samvera.org or on Slack) to schedule and announce!
these can be for Hyrax, Hyku, or can be broader Samvera
Heather is aiming to start notifying the Community next week (May 19-23) that these are in the works, will happen this summer.
Action Items
Folks are invited to take a look at & provide feedback on these recently-created and/or updated docs:
the Feature Matrix, add any comments/Qs into ticket: https://github.com/samvera/hyrax/issues/7096
Draft issue that needs decision: where should the Release Process go? - for draft: “Update Release Process page with Hyku info”
Documentation Tasks • samvera Doc days of Summer! Reach out to HGK if you want to help with these.
Retro (Plus / Delta)
Plus: what was good/went well? | Delta: what would be good changes to make for next time? |
|---|---|
The project board was great to have for listing tasks and seeing progress | A longer sprint (2 weeks?) |
connection with folks on the common goal. | a recording would have been great, but don't want to record every time. This would be helpful for folks who couldn’t attend all discussions to get a good understanding of the broad discussions of re-structuring data |
creation of new top-level outlines for both Hyrax and Hyku docs, which we can now plug things into - see | more Hyrax tickets for non-coding folks. There were a good number of folks from repo-mgr roles in this sprint, who were ready to dig in! Would have been helpful to have more Ready To Work tickets for contributors in these roles to work on. (Most tickets that were Ready for the sprint tended to be Dev-oriented). |
scheduling time for this, which I wouldn't have normally done | thought I could carve more time out in a week, but this will need to be a slow burn for me |
getting feedback on documentation in progress felt like a real luxury to me | some bulkrax tickets were in the sprint but we do not currently have bulkrax installed on the nuraxes to use as a tool for writing the documentation |
Appreciate the focus on improving community documentation |
|
I liked having a daily check-in meeting | perhaps more structure around the review process; decisions in advance about platform/destination of particular piece of documentation |
Learned a lot by reading documentation I wouldn't have even found. | Carving out focus group meeting time specific to Hyku, Hyrax, etc, or more technical documentation focus |
Meeting and getting to work with other folks in the Samvera Community in real time! Learned a lot from everyone in this sprint. | Having decisions noted as part of the check-in notes -> be deliberate about making sure these get recorded in a concise, clear, visible way. |
Working across Samvera services | documentation sounds boring, but it was fun to think about how newcomers or veterans could learn more and be as excited as us about the potential of the software. Almost like a broader focus? |
| Documentation Sprint with a specific end user in mind - Developers, Repo Managers, End User |
The momentum of being part of the sprint - helped with feeling very motivated to put effort into Docs so that people can understand about all aspects - the organization of Samvera projects, the repo systems, etc | Would be helpful to establish more clarity at a high level about the current status of what types of docs already exist in Hyku vs Hyrax projects. This could be just at a high level. For example, something like “Hyku has end user docs, but Hyrax really doesn’t yet.” The currently-underway Content Inventories for Hyrax and Hyku will help with this. |
Questions: