Skip to content

Latest commit

 

History

History
76 lines (64 loc) · 5.01 KB

File metadata and controls

76 lines (64 loc) · 5.01 KB

Documentation Interest Group — December 16, 2020 — 11:00 AM Eastern

Zoom: https://us02web.zoom.us/j/87888134747

  • Chair: Mirko
  • Notes: Melissa
  • Attending:
    • Mirko Hanke
    • Melissa Anez
    • Danny Lamb
    • Amy Blau
    • Janice Banser
    • Yamil Suarez

Resources

Agenda

Future discussion topics (timing TBD)

  • Accessibility
  • Cooperation with Lyrasis around IMLS grant for Fedora migration
  • Guidelines on the relationship between Readme files and documentation
  • Best practices for creating documentation about new features (cf. notes from 18 November 2020)
  • ICG Functional requirements list (cf. notes from 2 December 2020)

Notes

  • New footer is ready, just needs a review & merge
  • Rosie has a started PR for documenting features; still a work in progress and need contributors
  • Rosie built a brand new page on configuring viewers
  • New Documentation GitHub team is active; ask Melissa if you want to be added to it.
  • Material theme: tooltips from a glossary is a free feature that we really like. Some paid features sound nice (especially version support!), plus we'd like to support another open source project. Cost is pretty nominal.
    • The DIG will recommends to the ICC that we pay the $10/month to sponsor Material and access Insiders features. Mirko will present the case during the IG reports section of the December 18th ICC meeting.
    • Danny will have a look at the technical requirements to add the free features to our build
  • Lots of issues have the "documentation" tag, but not all seem relevant; maybe we can add the "help wanted" tag for those that might be doable for those in this group? {Filtered search](https://github.com/Islandora/documentation/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation+-label%3A%22Meta+Issue%22+) to remove the meta-issues makes the list more manageable. Our documentation spreadsheet is getting out of sync; Should we keep it updated? Update it just when we're about to do a lot of work? Seems more practical to just do it as needed.
  • Work continues on ICG functional requirements. Not yet ready to share outside the group.
  • Tracking what's going on in the community in terms of development could be really useful; less wheel re-invention. Topic for the ICC to discuss.
  • Janice and mark have writeen up a guide on how to add a facet on vocabulary reference fields that needs ot go through the process to become full-fledged documentation.

Action items

  • [] Update footer to include information about making changes to documentation
  • Delve into Material theme documentation to check for features that are possibly useful: https://squidfunk.github.io/mkdocs-material/
  • [] Test behavior of menu items which have children, possibly create landing pages
  • [] Danny will have a look at the technical requirements to add the free features to our build
  • [] Mirko to present request to sponsor Material to the ICC
  • [] Ask Rosie how she made the master list of documentation, so we can document how to document.

Standing items

  • Update documentation spreadsheet
  • Tend to Issue queue