2024-12-11 Documentation Working Group Agenda/Meeting Notes

2024-12-11 Documentation Working Group Agenda/Meeting Notes

Zoom Meeting Info

usually the second Wednesday of the month, 10am -11am EST / 16-17 CET / Time Zone Converter

https://openlibraryfoundation.zoom.us/j/89637604553 

Meeting ID: 896 3760 4553
Passcode: FOLIO Meetings with Zoom



Attendees: @Former user (Deleted)  @Christine Tobias  @Lisa Reeck  @Amanda Ros  @Alissa Hafele  @Lisa Lorenzo  @Wilhelmina Randtke  @Emily Semenoff  @Laurence Mini  @Stefan Dombek  @Aaron Neslin  @Martina Tumulla



Item

Who

Notes

Item

Who

Notes

Housekeeping

Katharina

note taker for today: Martina Tumulla

Next meeting is on Feb 12th at 9am EST / 15 CET

New meeting time in 2025! 9am -10am EST / 15-16 CET - Peter M. for Zoom Update was informed by Katharina

Review of the year

Katharina

  • Welcomed new writers

  • Improved our onboarding process

  • Wrote docs for 2 new releases

  • Decided on link policy

  • Structured official website with a new order in the left hand menu

  • Developed plans for updating website’s layout

  • Terminology document was published

  • Identified search problem with small screens

  • WOLFcon presentation

Announcements

All

PC endorsed Claiming App

Katharina: writer searching for Claming App started

Resources for doc wg updated: GitHub training by Molly, Flow chart for workflows by Aaron, GitHub weights by Katharina

Ramsons release postponed



some writers are working or updating their documentation, bugfest was really time consuming this time - Please let Julian and/or Ian know about your pull requests for Ramsons

Ramsons Documation is now available before the official release - Katharina will ask Ian and Julian about their advise

Wilhelmina wrote documentation on consortium manager. This is not visible in e.g. snapshot or the Bugfest - please use the Bugfest ECS enabled if you would like to take a look

Open actions last meetings

All

Katharina:  Contact to Julian concerning Docsy Upgrade still ongoing: 1st step update search engine, then theme

Link problems official doc website

Katharina

Some links in my testing didn't work, Stefan D. had the same

to do: All writers please check your links (internal and external) and fill out the table below for support resolving process

It would be good to know why those links are not working anymore and find the pattern why.

some suggestions

  • typos e.g. (....] instead of (...)

  • syntax of link [Settings > General > Aggregators](../settings_eusage#settings--general–aggregators)

  • Change the capitals in the links to lowercase

  • Add a / at the end of this link

  • Anchor

  • Be careful about extra spaces

WOLFcon review

Katharina

60 attendees in London and remote: questions concerning translation project and sharing training materials - link collection

Co-writing

Alissa/Katharina

Data Import group has a need for more documentation, would be good to have more writers for this larger topic

sharing experiences with co-writing solution would be helpful

Katharina: one person from the subgroup to address questions, new writers are welcome, list all writers in our table,

Reporting Group:

  • Meetings in zoom

  • Devided up reporting docs – work offline then

  • Review and discuss next time

  • Work together via Zoom on the docs

  • Reach out to PO for new content or questions

Discussion scope doc wg

Katharina

user documentation on our plattform 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 arournd 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

Amanada: official documentation being frontend and linking for backend documentation

Alissa: this is my approach for Ramsons

Aaron: developer document the APIs

DUE DATES





Sunflower



Sunflower is planned for April 2025

Documentation deadline as ever 1 week before: 

BACKLOG







open actions



  • Topic documentation archive + navigation in the different releases still open: first idea: use flower symbols from the releases on the top open

  • Finding a new place for "Install FOLIO", e.g. in GitHub open

Broken link collection