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

note takers for today: Christine Tobias, Laurence Mini

July 10 meeting canceled for summer break!

Next meeting is August 14.

note takers for the next meeting: Molly Driscoll, Emily Semenoff

Katharina: Amanda found new volunteer for settings > tenants in sys-ops channel: Aaron Neslin | Martina found new volunteer for eUsage - process ongoing |

Quesnelia was published May 31st - contacted Ian for bringing documentation online, too - done June 10th

• Significant edits made in GitHub were not pulled into FOLIO Docs.
• Aaron suggested giving someone in our Docs WG permission to view/edit Merges in GitHub (currently only Ian and Julian can approve).
• Settings_Service interactions: Enable number generator. Option appears in Quesnelia but no functionality at this time. Martina will handle documentation for this setting when it is ready.

PC: Patrick Pace was introduced as Developer Advocate / Development Documentation Working Group. (Documentation pertaining to development). 

Katharina: Summarized feedback concerning 'formalization application' to Jenn via Slack Channel | Topic documentation archive still open.

• Katharina will discuss topic documentation with Julian.
• No feedback yet received from Jenn.

Martina: Contact with Ingolf concerning a new place for documentation's section "install FOLIO". Target audience for this section is different from the rest of the docs – suggestion for placing this section in GitHub; remove from FOLIO Docs. 

Session accepted - "best practise: FOLIO documentation for professional training in institutions" → Accepted as part of community sharing sessions.

moderation: Katharina

speakers: Christine Tobias

Molly can help with remote support, editing slides etc.

• Will invite other Docs WG members to participate.

Katharina will get more information on the format of the session (hybrid? likely audience?)

Good to know for a better work distribution -

• How many people read the agenda before? (11 - all attendees)
• How many people read the notes when absent? (11 - all attendees) 
• How many people listen to the recording when absent? (6- some will listen if topic is relevant to them)
• How often do you check our slack channel - (daily - 5; weekly - 8) / notifications active? 
• How confident are you with the doc wg's wiki pages? (Yes - 8)
• Suggestions for improvement?
  
  • Consistency in content and structure across SIG's/WG's
  • Who maintains the documentation site (approving pull requests, etc.), who do we go to with questions, and what is their schedule for doing these edits/maintenance?

• Documentation workflows:
  • How many people use GitHub? | How many people use Google? |
  • Who can design short charts with the single steps?
    • Documentation about using GitHub is available on the FOLIO wiki. But a flow chart could be more useful for new writers/people learning how to use GitHub.
    • Aaron volunteered to start working on a flow chart and shared an example.
• Opinions: Mentors for new writers (e.g. contact for questions, introduction to doc wg pages, job shadowing...)
  • Good idea!
  • Christine "mentors" Lucy Harrison for Consortium manager and Settings > Consortium manager.

Laurence

Katharina

Short Paper for discussion and decision (Upgrade yes or not; what else do we need?, e.g. table of contents vs. sidebar)

Fix for searching documentation on mobile or smaller screens (issue: blank screen; no results). Fix seems to work - giving a pop up with results. Overall, search in the proposed new site works better compared with the current site – for example searching for SUSHI (used in eUsage) in the current site shows no results, does find result in proposed new version, although also finds false positives. Main issue with new version is the the search result just goes to the top of the section (e.g. Users) instead of the specific place in the section where the search term is used.

Decision to upgrade will be discussed at next meeting.

Ramsons public release is planned for Nov 18

Ramsons documentation deadline as ever 1 week before: Nov 11 is the aim