2025-03-12 Documentation Working Group Agenda/Meeting Notes
- Katharina Jung
- Laurence Mini
Zoom Meeting Info
usually the second Wednesday of the month, 09am -10am EST / 15-16 CET / Time Zone Converter
https://openlibraryfoundation.zoom.us/j/89637604553
Meeting ID: 896 3760 4553
Passcode: FOLIO Meetings with Zoom
Attendees: @Laurence Mini @Katharina Jung @Molly Driscoll @Christine Tobias @Stefan Dombek @Ben Taylor @Lisa Lorenzo @Emma Raub @Alissa Hafele
Item | Who | Notes |
|---|---|---|
Housekeeping | Katharina | note taker for today: Laurence Mini note taker for next meeting: Molly |
Announcements | All | Aaron: will be taking on the version information along with tenant settings Katharina: New writers for Claiming: Susanne Gill, Stephanie Kaceli, Ben Taylor Ben is a librarian at Trinity College in Cambridge, UK. Susanne, Stephanie, and Ben have agreed on how to split up the Claiming documentation amongst them. |
Open actions last meetings | All |
|
Discussion scope doc wg / additional topics policy | Katharina | user documentation on our platform by using our resources survey "things could be better about FOLIO" - wish for tips/tricks, troubleshooting, tutorials etc. | 2x additional topics online (Molly, Laurence) | Tips and Tricks wiki Alissa: data import allows the users more access than clicking around in the UI e.g. using postman / Are we going beyond the UI? Where is the line? Christine: scope is documentation the enduser interface and things beyond added to Wiki or github and we provide an external link Amanda: official documentation being frontend and linking for backend documentation Alissa: this is my approach for Ramsons Aaron: developer document the APIs What belongs in the Documentation versus the Wiki - Tips and Tricks section? General agreement that UI-related topics belong in the Documentation. Topics related to the APIs, workflow or “back-end” stuff should be in the Wiki or GitHub, and can be linked as an external link from the documentation. Agreement that individual writers should decide what belongs in the Documentation. Some sections (acquisitions, RA) get questions asked in Slack more frequently than others. For example, Molly has heard from members of the Acquisitions WG that they would like more information about Order Status, and how that affects workflow. Users can have “documentation fatigue” with too many places to check for documentation, nice to have all in one place. Rather than have long tables disrupt flow of documentation, have in “Additional topics” subsection. Central Ordering section covers options that libraries that don’t have ECS environment won’t see. Data Import is very complex, and only describing “which button does what” is inadequate for the folk who use DI. Examples of things that might belong in an “Additional topics” section are long tables, things that cross multiple apps (such as fees/fines), or things that are only used by some institutions (such as institutions using an ECS setup). |
Settings documentation | Laurence | Settings > My account now has two subsections: Application display order and Change password. WG members agreed that it would be good to add a Settings > My account section to the documentation. Christine agreed to take on documenting the Settings > My account for Sunflower. |
WOLFcon 2025 | Katharina | Call for proposals until Fr April 11th |
Sunflower / Eureka Permissions | Katharina | 2 new sections in settings app: Authorization roles & Authorization policies instead of permission sets. Changes for https://docs.folio.org/: strategy and template needed!
Some libraries may keep Okapi implementation in Sunflower while others might switch to Eureka. WG members may not have enough time to make changes by Sunflower. Given differences in permissions for different apps, it may make more sense to have permissions for an app described in the documentation for that app, as is current practice. Also, putting all the permissions together would make for a very long list. See Eureka Timeline. |
DUE DATES |
|
|
Sunflower |
| Sunflower is planned for the end of April 2025 (bug fest March 24th - April 11th) Documentation deadline as ever 1 week before: April 21st |
Trillium |
| Trillium is planned for November 10th 2025 (bug fest October 3rd - 24th) Documentation deadline as ever 1 week before: November 3rd |
BACKLOG
|
|
|
open actions |
|
|