Documentation meeting 29 May 2024

From Koha Wiki
Jump to navigation Jump to search

Place

Video conference meeting using Jitsi at https://meet.jit.si/KohaDocumentationMeeting

  • We are using an (open source) video conference platform for the discussion part of this meeting. You don't have to turn your camera on if you prefer not to be seen; but if you are able to use a mic it should make our conversations a lot easier!
  • To join the meeting, click on the meeting link. If you are on a desktop computer, it will open in a browser window; no need to install anything. To join on a mobile device, you will need to download the Jitsi Meet app (from Google Play; from Apple Store).
  • Browsers will ask for permission to use video and audio devices: check or review these settings if you have audio or video issues.
  • Supported browsers | Mobile application

We will use the #koha IRC channel (IRC server irc.oftc.net) to record the meeting minutes, including #info and #action information. Feel free to login there too (if you don't have an IRC client you can use your web browser.)

Time

Apologies

Add your name here if you would have liked to attend but can't make it.

  • David Nind
  • Emmanuel Bétemps

In attendance

  • Philip Orr, LMSCloud, Germany
  • Aude Charillon, PTFS Europe, UK
  • Caroline Cyr La Rose, inLibro, Québec, Canada
  • Marie-Luce Laflamme, inLibro, Québec, Canada

Updates

Review of action points

  • See previous meeting.
  • Accessibility
  • Aude to prepare a shared notepad for non-IRC minutes. DONE
    • Shared notepad in use! Aude will tidy-up notes and paste them into this meeting's Wiki page.
  • Marie-Luce and Philip to test the "Start Jitsi Meeting" function in the Mattermost Documentation channel ahead of this meeting. DONE
    • Does it work? Can people who aren't on Mattermost join?
      • It works, but people who are not on Mattermost will need the URL of the Jitsi Meeting to join directly in their browser
      • However since perplexedtheta fixed Jitsi Mattermost implementation, when you click on "Jitsi Meeting" in mattermost, the meeting is opened in your browser anyway.
      • Not much of a time saver compared to just staying with our "permanent" documentation meeting link mentioned above; actually probably more work to try to do it over mattermost.
    • If ok, use this function for the next meeting. NOT OK - we will continue to use the more "permanent" Jitsi link above for now.
  • Aude to close GitLab issues 8 and 42, and remove mentions of a PDF Manual on the Koha community website. DONE
  • Caroline to move the MarcEdit section of the manual to a wiki page.
  • Indexing of old manuals in search engines. SUPERSEDED - See Documentation workflow section below.
    • Caroline to flesh out the options, ready for us to vote on at the May meeting.

What the team has been working on

  • Caroline has been working on the permissions section: adding headings, anchors (to directly link to the correct permission) and more details about their use.
  • Aude had a meeting with Philip regarding the handover of the Documentation Manager role.
  • Philip has been looking at dates for Docs meetings for next cycle and varying times.
  • Emmanuel is planning to tackle the notices and slips section of the manual (if nobody else wants it) - Bug 35855
    • NOTE from meeting: all yours!

Ongoing projects

Automated screenshots (Jonathan, Caroline, Aude) - Bug 34076

  • ACTION Aude will drop Joubu a message in the Documentation chat to check where we are up to and how we can help.

Re-organising the manual (David Nind) - Bug 32391

  • David will submit the merge request this week (with apologies for the delay).

Accessibility issues in the Manual (Philip and team) - Wiki page

  • GitLab issue 44: colour contrast all sorted. Thanks to Philip and Caroline!
  • Philip will create GitLab issues for each of the points raised in the audit.
  • Next priority: fixing the search box.

Documentation workflow: issues and ideas

Older Koha versions' manuals (Aude)

What should we keep? The background:

  • We've had an issue with server space, causing the translated manuals not to synchronise. Joubu fixed this by moving the manuals of unsupported Koha versions (all languages) to a local storage. There is currently a redirect to latest in place; but now is the time to make some tough decisions.
  • For more information, see discussions on Mattermost: how it started and where we got up to.

What we decided in the meeting:

  • DECISION We only want to support Koha manuals for supported Koha versions.
  • ACTION Aude to unpublish https://koha-community.org/documentation/documentation-unsupported-versions/ and also:
    • update the page for legacy versions;
    • add a mention of where the "Help" link goes on older Koha versions.
  • ACTION Aude to check with Joubu how long the files will be kept in his local repository.
  • ACTION Philip to inform the Koha general list afterwards (what we decided, where and when to download old manuals if people want them).

Content Development Guide

SKIPPED No time to discuss at this meeting.

Ongoing work to build a Documentation content development guide.

  • Anything recently added to the page that people want to review or discuss?
  • Questions to cover (please add yours too!)
    • Use cases: how can we include more of these to better show how Koha features are used together?
      • Formatting; where to insert them (new chapters or sections needed?)
    • Screenshots
      • Do we need a recommended image size / resolution?
      • Point to guide on how to write good alt text
    • ...

Anything else

Reminders

Next meetings

ACTION Philip to share dates and times for all meetings in the 24.11 cycle.

ACTION Aude to add them to the Koha community calendar.

ACTION Aude to coordinate with Philip to plan an online Documentation workshop in July.