2025 August/Sept Documentation Subgroup

2025 August/Sept Documentation Subgroup

Members:

@Christie Thomas

@Olamide Kolawole

@Shelley Doljack

Goals:

  • Inventory wiki

  • Propose an information architecture to the TC - September 2025

  • Implement approved architecture

Next Steps:

2025-10-1:

I updated the IA and moved 📄 TCR Process Improvements - Fall 2023 from Technical Reviews to Historical subgroups (where it currently resides based on the content of that page). - sdoljack 9/23/2025

2025-09-10:

Get approval from TC on the proposed architecture (approved Sep 15, 2025)
Implement it!

Proposed Information Architecture:

Technical Council (TC) ├── 📄 FOLIO - Developer Onboarding Index ├── 📁 Meeting notes │ ├── 📁 2025 │ │ └── [All 2025 meeting notes] │ └── 📁 Archived │ ├── 📁 2018 │ │ └── [All 2018 meeting notes] │ ├── 📁 2019 │ │ └── [All 2019 meeting notes] │ ├── 📁 2020 │ │ └── [All 2020 meeting notes] │ ├── 📁 2021 │ │ └── [All 2021 meeting notes] │ ├── 📁 2022 │ │ └── [All 2022 meeting notes] │ ├── 📁 2023 │ │ └── [All 2023 meeting notes] │ └── 📁 2024 │ └── [All 2024 meeting notes] ├── 📁 Governance │ ├── 📄 Technical Council Charter review 2025 │ ├── 📄 Technical Council - Governance Decisions │ ├── 📄 TC Roles and Responsibilities │ ├── 📄 Technical Council Meetings and Notes │ ├── 📄 Recurring Calendar │ ├── 📄 Technical Council Special Election (Nov 2024) │ ├── 📄 Technical Council Membership History │ └── 📁 Quarterly Community Updates │ ├── 📄 Quarterly Community Update (Q2 2022) │ ├── 📄 Quarterly Community Update (Q4 2021) │ └── 📄 Quarterly Community Update Q1 2022 ├── 📁 Technical Standards & Policies │ ├── 📁 Officially Supported Technologies │ │ ├── 📄 WIP - Policies and Reasoning │ │ ├── 📄 Lotus │ │ ├── 📄 Morning Glory │ │ ├── 📁 Nolana │ │ │ └── 📄 JDK 17 and Java 17 │ │ ├── 📄 Orchid │ │ ├── 📄 Poppy │ │ ├── 📄 Quesnelia │ │ ├── 📄 Ramsons │ │ ├── 📄 Sunflower │ │ ├── 📄 Trillium │ │ └── 📄 Umbrellaleaf │ ├── 📄 Definition of the Okapi-Stripes Platform, FOLIO LSP Base and FOLIO LSP Extended Apps │ ├── 📄 DRAFT: Breaking changes best practices │ ├── 📄 Security Issue Policies and Processes │ ├── 📄 0004-iso-8601 │ ├── 📄 Browser support │ ├── 📄 Component Owners │ ├── 📄 Managing Tools/Frameworks/Dependencies Version - v0.1 DRAFT │ ├── 📄 Managing Tools/Frameworks/Dependencies Version - v0.2 DRAFT │ ├── 📄 FOLIO Release Numbering Policy │ ├── 📄 Removing mod-configuration after Sunflower release │ └── 📄 Technical Debt ├── 📁 Decision Records │ ├── 📄 DR - Process Overview. # add this info to the parent page, potentially. │ ├── 📄 DR - Step By Step Instructions │ ├── 📄 DR - Workflow for Decisions │ ├── 📁 Decision Log │ │ ├── 📄 DR-000001 - Use Kafka as the distributed event streaming platform │ │ ├── 📄 DR-000002 - Tenant Id and Module Name Restrictions │ │ ├── 📄 DR-000003 - Morning Glory support period │ │ ├── 📄 DR-000004 - Cross application data sync proposal │ │ ├── 📄 DR-000005 - Platform agnostic object storage for Exports │ │ ├── 📄 DR-000006 - Apache Kafka Usage in Inventory Storage │ │ ├── 📄 DR-000007 - Back End Module Health Check Protocol │ │ ├── 📄 DR-000008 - Data export by using Spring Batch (aka Export Manager) │ │ ├── 📄 DR-000009 - Handle i18n where messages are generated │ │ ├── 📄 DR-000010 - Include instance id in the inventory-storage notifications for items │ │ ├── 📄 DR-000011 - Karate test framework for Integration Tests │ │ ├── 📄 DR-000012 - Localization parameter for back-end │ │ ├── 📄 DR-000013 - Log4j2 is the recommended logging library for all core java modules │ │ ├── 📄 DR-000014 - Migration of Static Permissions Upon Upgrade │ │ ├── 📄 DR-000015 - Optimistic locking support │ │ ├── 📄 DR-000016 - Personal Data Disclosure Process │ │ ├── 📄 DR-000017 - Pull Request Guidelines │ │ ├── 📄 DR-000018 - Should build (pom.xml) changes required by new RMB be considered breaking? │ │ ├── 📄 DR-000019 - Spring Way Equivalent of Edge-common │ │ ├── 📄 DR-000020 - Teams must document deployment requirements in a clear & consistent way │ │ ├── 📄 DR-000021 - UI Testing approach │ │ ├── 📄 DR-000022 - Upgrade to JDK 11 │ │ ├── 📄 DR-000023 - Use of Testcontainers for test infrastructure │ │ ├── 📄 DR-000024 - Deletion of core-module records may leave dangling references from non-core modules │ │ ├── 📄 DR-000025 - Karate API Integration Tests Implementation Guidelines │ │ ├── 📄 DR-000026 - S3/MinIO │ │ ├── 📄 DR-000027 - Check Out Performance │ │ ├── 📄 DR-000028 - FOLIO should define a minimal platform │ │ ├── 📄 DR-000029 - Data consistency and message driven approach │ │ ├── 📄 DR-000030 - FOLIO Secrets Management │ │ ├── 📄 DR-000031 - Teams to implement UI end to end integration tests │ │ ├── 📄 DR-000032 - Splitting Database Read/Write Traffics │ │ ├── 📄 DR-000033 - Process for Managing Tools/Dependencies/Frameworks │ │ ├── 📄 DR-000034 - Java 17 Support │ │ ├── 📄 DR-000035 - Kafka Tenant Collection Topics │ │ ├── 📄 DR-000036 - Breaking Changes │ │ ├── 📄 DR-000037 - TESTCONTAINERS_POSTGRES_IMAGE │ │ ├── 📄 DR-000038 - PostgreSQL Upgrade to 16 │ │ ├── 📄 DR-000039 - Distributed vs. centralized configuration │ │ ├── 📄 DR-000040 - Deprecation Policy │ │ ├── 📄 DR-000041 - Eureka Adoption │ │ └── 📄 DR-000042 - FQM RFC │ ├── 📄 DR - DR-nnnnnn - < Decision Template> │ └── 📄 DR - FAQs ├── 📁 Archive │ ├── 📄 2023 Charter Draft Archived │ ├── 📄 Folio Architectural Blueprint Strategic Changes │ ├── 📄 FOLIO AWS Budget │ ├── 📄 The Codex Vision - TC Review │ ├── 📁 Tech Council Request/Backlog Page │ │ └── 📄 Code Repository Management │ ├── 📄 Tech Council Upcoming Meeting Agenda Items │ ├── 📄 Technical Skills in Demand │ ├── 📄 Translation File errors │ └── 📄 Voting Rule Comparisons ├── 📁 Technical Council Subgroups │ ├── 📁 Documentation subgroup │ │ ├── 📄 2024-06-04 Meeting notes │ │ └── 📄 Technical documentation items from 'things that could be better' survey │ ├── 📄 Licensing Subgroup │ ├── 📁 Static Code Analysis Subgroup │ │ ├── 📄 2024-06-18 Meeting notes │ │ ├── 📄 2024-08-06 Meeting notes │ │ ├── 📄 2024-08-20 Static Code Analysis Meeting notes │ │ ├── 📄 2024-11-12 Static Code Analysis Meeting notes │ │ └── 📄 Examples of Code Duplication Metrics and Code Smells Severity │ ├── 📁 Technical Council Goals/Objectives Subgroup │ │ ├── 📄 2022-04-25 TC Goals & Objective Meeting notes │ │ ├── 📄 2022-05-02 Meeting notes │ │ ├── 📄 2022-05-09 Meeting notes │ │ ├── 📄 FOLIO Project Technical Objectives & Initiatives │ │ └── 📄 Technical Council Goals & Objectives - NOT IN USE │ └── 📁 Historical Subgroups │ │ ├── 📁 Controlling AWS Hosting Costs subgroup │ │ │ ├── 📄 2023-04-07 Meeting Notes │ │ │ ├── 📄 2023-04-14 Meeting Notes │ │ │ ├── 📄 2023-04-21 Meeting Notes │ │ │ ├── 📄 2023-04-28 Meeting Notes │ │ │ ├── 📄 2023-05-05 Meeting Notes │ │ │ ├── 📄 2023-05-12 Meeting Notes │ │ │ ├── 📄 2023-05-19 Meeting Notes │ │ │ ├── 📄 2023-06-02 Meeting Notes │ │ │ ├── 📄 2023-07-28 Minutes │ │ │ ├── 📄 2023-08-04 Meeting Notes │ │ │ └── 📄 AWS Cost Review Subgroup │ │ ├── 📁 Kafka Partitions RFC Subgroup │ │ │ └── 📄 TC Subgroup RFC Kafka Partitions Meeting Notes 2023-01-31 │ │ ├── 📄 TC Subgroup: Distributed vs. Centralized Configuration │ │ └── 📄 Technical Evaluation Process Subgroup | │ ├── 📄 TCR Process Improvements - Fall 2023 ├── 📁 RFC (Request for Comments) │ ├── 📄 RFC Process │ ├── 📄 RFC Template (Title goes here) │ ├── 📄 RFC Branching Guide (Deprecated) │ └── 📁 RFC Log │ ├── 📄 0000-pub-sub │ ├── 📄 0001-localizing-api-messages │ ├── 📄 0002-kafka-tenant-collection-topics │ ├── 📄 0003-folio-breaking-changes │ ├── 📄 0004-iso-8601 │ ├── 📄 0005-application-formalization │ ├── 📄 0006-application-management │ ├── 📄 0006-folio-distributed-vs-centralized-configration │ ├── 📄 0007-application-specific-ui-bundles │ ├── 📄 0008-bounded-contexts │ ├── 📄 0009-golang │ ├── 📄 0010-eureka │ ├── 📄 0011-Folio Query Machine (FQM) │ └── 📄 0012-Folio Deploy Environment Variable Naming Conventions ├── 📁 Technical reviews │ ├── 📄 Defining data types in FOLIO for automatic upgrades │ ├── 📄 Documentation Platform/Tools Review │ ├── 📄 Improved Handling of Reference Data During Upgrades │ ├── 📄 OTS Project Health Report │ └── 📁 New Module Technical Evaluations │ └── 📄 Approvals by Release