Page Comparison

Technical Council Sub-Groups Updates

Developer Docs

• proposal later on agenda
• Jeremy Huff Going well thanks to Patrick's productivity.

Reminder(s)

• Go RFC still open - admin action required, only a PoC - nothing formal required other than closing the pull request.
• Still Need Decision Log record for application formalization, Go, configuration RFCs

•  The Security Team is seeking formal approval to add Jens Heinrich and Kevin Day as members.
• Jens Heinrich Works at IdM working group for German FOLIO project.  Designing how to sync FOLIO and current identity solutions.  Moving from implementing work to mostly security.  Security critical for libraries and libraries for universities.
  • Craig McNally Jens was also participated in API fuzzing to discover vulnerability, by network security operations group.
  • Jens Heinrich Modern tooling expects OpenAPI spec not RAML.  Got stuck behind higher priorities but could start again with conversion to OpenAPI spec.  Also on GDPR conformity part of HEBIS.
• Craig McNally Kevin Day (TAMU) has been a full-stack dev.  Workflow, camunda modules.
  • Jeremy Huff He is tech lead for the workflow work.  Work at TAMU not just FOLIO.  Very security-minded, involved in different technical communities' security concerns.
• TC approved new personnel by lazy consensus.

• /wiki/spaces/DDG/pages/283934733
• Patrick Pace (Unlicensed) If approved, it will serve as the initial form.  Planned to be fluid.  But should be logical & organized so a new developer could read through the manual, be ready to develop.  Veteran can find exactly what they're looking for rather than only depending on search.
  • Logical progression of major sections
    • Introduction to FOLIO.  Expectation of a development background, but not FOLIO.
    • How to Use This Manual.  And how to contribute.
    • Accessing the FOLIO Toolstack.
    • Core Technical Concepts (4) and Advanced Technical Concepts (6) have balancing.  But the idea is not to get deep very quick.  Have conceptual stuff precede the practical stuff.
    • Development in Practice.  I.e. style guide.  Finding an issue, starting to contribute.
    • Advanced Technical Topics.  All the detail we want.  So developers can do so "well".
    • Tips, Tutorials, Examples and Templates.  Building on the technical details.  Things that can be re-used.
    • Reference.  Like source code map, API documentation.
    • Appendices.  Anything that doesn't have a place elsewhere.
• Jens Heinrich First section is about FOLIO as a project?
  • Patrick Pace (Unlicensed).  Yes.  Mostly links, not duplicating.
  • Jens Heinrich People might expect an architectural introduction there.
  • Patrick Pace (Unlicensed)  Maybe renaming Core Technical Concepts to be clear it's the architectural introduction.
  • Jeremy Huff Add the word 'project' to #1, i.e. "introduction to the FOLIO project"
• Jeremy Huff The version of FOLIO that the document relates to should be clear.
  • Patrick Pace (Unlicensed) Functional docs group does that, so precedence.  Need input on that.
  • Jens Heinrich How much of the documentation is release dependent?  Seems not much.  Only 6 and upwards very dependent on the release.
  • Jeremy Huff Esp with application formalization, sections 4-6 may change a lot.
  • Maccabee Levine Suggest focus on the current version, perhaps callouts / sidebars with "Prior to release X, something different".
• Jeremy Huff Does TC need a process in place for significant changes to the manual in the future?
  • Patrick Pace (Unlicensed) Hopefully there will continuously be incidental changes.  Dev documentation group would have regular reviews.
• Jenn Colt Comfortable accepting this, knowing it can evolve and dev documentation group can manage the changes.
• Approved by lazy consensus.

Officially Supported Technologies (OST)

• Maccabee Levine Is this the same as the PC subgroup working to improve sample data?
  
  • Marc Johnson Not sure.
  • Tod Olson Thought we were taking about the same thing as the group a lot of people were on for a while.
  • Craig McNally Reference data working group a couple years ago is what sysops is taking about.  Not sure if it's the same as the sample data group.
  • Tod Olson Was much more involved the last time.
  • Maccabee Levine Just make sure the two groups are aware of each other.
• When Ingolf Kuss returns, can get more info.
• Tod Olson This new PC group is about sample data.  Years ago data was contributed.  Now new functionality, there are no sample data test cases.
• Maccabee Levine Example, in snapshot there are no orders connected to any invoices.
• Tod Olson Reference data can be customized (i.e. material types) or added to, but often is not.  Some stable conventions are needed for the reference environments.  It's a fuzzy boundary.
  • Craig McNally System data is a third category.