Content Comparison

• Current state of the installation content
• Folio docs page https://docs.folio.org/docs/

Meeting Notes:

• Marcia shows the folio.org docs page.
  
• Content is structured on the site; SysOps documentations (so far) are in
  • Install Folio
    • Single Server with Containers
    • Single Server without Containers
    • Kubernetes example
    • Vagrant boxesand
  • Additional configurations (e.g. Securing Okapi, E-Mail configuration).
• Documentation starts with the demo site, then adresses core vs. complete if you want to install Folio yourself.
  
• So far, the site is in draft status. Marcia is working on a v1 - version. In team of Marcia are  José  Enrique Ortiz Vivar and Lauren Gallina (Google Seasons of Docs writers). Also Patty is involved in it.
  
• Not all documentation should go to the docs.folio.org site. Documentation there should be for a public interest.
• Question is: How much technical documentation do we want to have ?
• Marcia is leading an editorial process.
• Marica shows us Administration - Settings section. Circulation and Courses.
• Documentation is being written according to Google developer documentation style guide .
• Documentation is written in github with https://github.com/google/docsy . Here: https://github.com/folio-org/docs .
• Thus, documentation is versioned.
• At the moment, only the tech writers can edit. In the long term, as it is an open source project, the ideal vision would be that anyone should be able to edit the documentation in github. But we need an editorial process. So, Marcia, as the editor, will approve the pull requests - or reject them.
• In general, we need communication for things to become part of the documentation. SysOps SIG will invite Marcia from time to time to discuss their ideas.
• Documentation needs a well-defined structure, documentation is part of Folio's business card to the outer world.
• During a release cycle, Marcia will have someone to look over the current documentation.
• The site will keep documentations for old releases.
• Marcia created the DOCS project in issues.folio.org, JIRA DOCS project . Documentations for new JIRA issues will initiated here. Any changes will go to JIRA. "What is the impact of this change on the (documentation) content" will be discussed here.
• Marica wants to include Localization in the documentation: language / terminology / flow .
• Marcia asks us for feedback and comments on the current site structure. What would we like to see there ?
  • Answers of SysOps SIG:
  • SysOps/Admin pages in the draft site look awesome, thank you Marica and team.
  • Documentation for data migration. How to migrate different types of data (Users, MARC; Non-MARC). What endpoints/APIs to use ? What are the experiences with performance ?
  • Customization and data migration - apart from installation - are crucial when setting up a system for a customer.
  • We need to point people to some of the add-ons; e.g. Jon Miller's (of Chicago) programs for data migration. We don't need to maintain the documentation itself on the folio docs site, but take the people to the documentation of the add-ons.

All agree that documentation is an integral part to make Folio a successful product that customers want to use. We continue to need a strong lead in the documentation efforts !

Next meeting will be on January 8th.

Happy Hanukkah Chanukkah and Merry Christmas ! Happy Holidays & see you next year (hopefully a better year than 2020).