Samvera Community Wiki
Documentation Notes: Kickoff and Check-ins for Community Sprint May 2025
We'll record group updates here in case there's anyone who misses the call
Information and links:
The Zoom meeting room is open for working together anytime
The #documentation channel is Slack is available to get help, share drafts, request review, etc.
Anyone can update in this wiki; Heather can update the websites (immediately or with help later); GitHub wikis can be updated directly in Github - if you need access just ping Heather.
Links for some places to find information/documentation to review:
General information areas: Samvera website, Hyku website, Hyrax website, Hyku documentation wiki space
Developer information areas: Hyrax Github wiki, Hyku Github wiki, general developer resources knowledge base, Hyku documentation wiki space
Kick-off meeting Monday, May 12, 2025
Welcome!
reviewing goals and tools
Check-in meeting Tuesday, May 13, 2025
Several things that would be easy in https://hyku.samvera.org/ but no editing privileges?
Note the other public-facing info sites: https://hyrax.samvera.org/, http://samvera.org, https://avalon.samvera.org/ – not sure whether Docs IG members have been considering these in the work!
Amanda made a ticket for http://hyku.samvera.org and seems that Heather has access for these sites - see ticket https://github.com/samvera/hyku/issues/2562
Need some discussion about what should live where - some things are duplicated - having things in only one place would be good -- OK, how to consider this?
Consider in terms of who the end user is - for example, public-facing documentation, developer documentation, etc. for other audiences
Example Avalon -- end-user documentation lives on Samvera wiki, and the Avalon public site points to that
What's in confluence wiki vs. what's in GitHub wiki?
How to classify developer docs vs. end-user docs? (For example, stuff that can be done in admin dashboard vs. stuff that has to be done by developer / in console?)
Another documentation location: Google docs!? Per Jessica, there are multiple links to Google docs from wiki - see this page, which links to multiple google docs – example here and another example (see action items, we want to move any important documentation out of Google docs into either Confluence wiki, GitHub wiki, or public site)
Would it be helpful to identify a desired end state? For example, with categories of documentation as end-user, developers, etc. I’m concerned that if we just focus on individual tickets, that we aren’t solving the right problems.
What about a hybrid approach? 1) Create tickets to fix things we know are wrong and also 2) create tickets or other to-do captures to move us in the direction of a better organized body of documentation
Do we need a working doc that’s bigger than a ticket for the larger conversation about organizing all the documentation??
We think that we do! And, such a document has already been created! Documentation Working Group Work in Progress
Do we intend our work to include all Samvera (Hyrax, Hyku, Avalon)?
Yes; Avalon may be under-represented, but Avalon has some great documentation work in place, see https://avalon.samvera.org ,
Avalon Media System
Action items
When we discover Samvera documentation that points to a Google doc or is a Google doc, make a ticket
Still encountering some problems with GitHub ticket-editing access - ping Heather for permissions or check invitations
Contribute to Bigger Planning for Samvera Documentation – categories including Buckets, Audiences, Docs that need to be corralled (link and description, some potential for overlap with board, add link to ticket if exists)
Check-in meeting Wednesday, May 14, 2025
Review action items from yesterday
Discuss Proposed Hyku Documentation Structure and next steps
Short updates on other work, any blockers, and review requests
Other items?
Action items:
A Hyrax documentation space in confluence
A history of the community and the different platforms
Will use the Hyku structure for the Hyrax space
Documentation days! Will get plan in place
Check-in meeting Thursday, May 15, 2025
Review action items from yesterday
status of action items:
A Hyrax documentation space in confluence -> DONE
the Hyrax Doc space so far contains proposal: https://samvera.atlassian.net/wiki/pages/createpage.action?spaceKey=HD&title=Proposed%20Hyrax%20Documentation%20Structure
also: “Hyrax Documentation Structure Summary [NEW]” - which was based on the Hyku structure.
A history of the community and the different platforms
needs a card on the board (if not there yet)
Will use the Hyku structure for the Hyrax space
this is done
Documentation days! Will get plan in place
in progress! HGK has this on her radar, will set these up
Short updates on other work, any blockers, and review requests
Content Inventory in-progress! Chrissy putting together google sheet to map out pages that can be linked up or created for Hyrax within the new confluence wiki structure - https://docs.google.com/spreadsheets/d/16Svm2zTZN1r-cqS9rSnPzmwXfikFrbO7Uvad84m22Hk/edit?gid=0#gid=0
this should probably live on Hyrax Interest Group Google Drive (Heather can help move that around)
Review request from Rebekah Kati - https://github.com/samvera/hyrax/issues/7087
Other items?
Next steps after this sprint? Especially with new Hyku structure?
Q: do we have a way to tag who is working on what?
A: No. OK to just grab tasks that look available and work on them.
No particular process decided on, can see if other folks are editing when you try to edit so that can help avoid conflicts and you should go for it if no one else is editing!
No reference in new Hyku structure to Hyku.samvera.org site but assuming we need to keep that around and fit it into this structure
confluence wiki structure could be considered more focused on details that could be connected to Hyku.samvera.org but that site is more like a front door to the confluence wiki that provides the details and is easier to keep up-to-date
Start Hyku content audit (similar to what is happening for Hyrax)!
Nick Homenda - updating Hyrax feature matrix (currently only have 1.0 and 2.0); need to organize by usefulness of feature instead of chronological order; the part of matrix that is comparing to other platforms, not sure this is useful or in scope to do outside of Samvera (group agrees)
https://github.com/samvera/hyrax/wiki/Feature-matrix - this is more for devs to know what features are available in which versions of Hyrax
different from feature matrix that explains all of the latest features available in latest version of Hyrax for interested folks (inside and outside of Samvera) and compares to other Samvera products (like Hyku)
Outreach and Communication group also working, but no conflicts with this documentation work (focused on websites only)
Feedback and retrospective mtg tomorrow (Friday 3pmET/noon PT)
even if you can’t make the mtg, feel free to put any ideas about what worked well/or not - into slack!
Hyrax Documentation Structure Summary [NEW]
Action items:
Wrap-up and retrospective Friday, May 16, 2025