This page lists the requests and/or items that the technical council is reviewing.
NEW REQUESTS may be added directly to the "Requested" table, or the requestor can ask via email to the council's mailing list. You can also reach out directly to members of the Tech Council.
Each inquiry should cover the following:
Item: In a very concise way, describe the problem that needs to be addressed.
Problem Statement/Background: Set context by describing the landscape surrounding the issue (history, technical components/versions, teams, etc.)
Interested Parties: Who will be impacted by a decision and if possible, what are their perspectives on this request.
Requested Action: What, specifically, are you asking the TC to do?
Current Items:
Item | Problem Statement/Background | Interested Parties | Requested Action | Requested By | Request Date | Current Status | TC Lead |
---|---|---|---|---|---|---|---|
Definition of Done | A community project needs documented best practices and expectations, especially in the area of quality control. A clear definition of done (DoD) is an important artifact that individuals and teams can measure their progress against. We rely on shared commitment to quality and the open community | PC, TC, Community, Developers, QA, DevOps | Create a document. | TC | June 14, 2018 | Draft exists - teams will "Beta" the process | Mark Veksler |
Evaluate and improve on boarding documentation | We are expecting an increase in contributors to FOLIO and want to make sure there is solid documentation so that they can be effective with as little lead time as possible. | Community, new contributors, | Create a list of recommended changes/additions. Secondarily, make actual changes. | TC | June 14, 2018 | New/reorganized documentation underway | Zak Burke |
Document the reporting architecture supported by FOLIO | The FOLIO Issue UXPROD-330 makes a statement that folio data and audit trail data will be fed to an external data lake and that Institutions will need to host own data lake and reporting/bi solution, but once they do, they will have access to all FOLIO data plus information about changes (e.g. who changed what and when). The TC should validate that this IS the design for the platform, and that the work that might need to be done to Okapi is understood and prioritized appropriately. Also, should Audit data be separated from Analytics data, and if so, how? | PC, TC, Community, Soon-to-be-active Developers | Document design pattern, decisions, work to be done and open issues around the Platform's reporting design. | Mike Gunning | June 25, 2018 | RFC Draft being considered. | Mark Veksler |
UI Testing Spike | Anton Emelianov (Deactivated)'s #1 observation was that there is a lack of guidelines related to UI Testing in the FOLIO project. This puts quality and productivity at risk. | Community, TC, PC | Assemble a task force to execute a spike to review testing tools, processes, etc. and to establish a set of guidelines. The outcome of this effort would be: - UI Testing Guide, including specific tools, that will enable different teams to follow best practices in building UI unit tests. | July 18, 2018 | Kick-off meeting being scheduled | delegated to Anton Emelianov (Deactivated) | |
Insufficient build processes | Anton Emelianov (Deactivated)'s #2 observation was that the build process is immature and/or fragile. Issue was described in - FOLIO-1335Getting issue details... STATUS - FOLIO-1338Getting issue details... STATUS - FOLIO-1043Getting issue details... STATUS | Community, TC, PC |
| July 18, 2018 | Core Team is working the issue | Zak Burke | |
Repo management | There are a few unmaintained or deprecated repos. Would like to regularly review and end of life those repos that are not longer maintained . Also, would like to ensure that every repo has at least one reviewer and their approval before a PR can be merged. | TC, Community |
| Mark Veksler | June 27, 2018 | Starting Review | |
Requested:
Item | Problem Statement/Background | Interested Parties | Requested Action | Requested By | Request Date | Current Status |
---|---|---|---|---|---|---|
Review of the Stripes architecture | to be determined | June 24, 2018 | waiting more info | |||
Stripes Testing | to be determined | June 24, 2018 | waiting more info | |||
CI Builds: Travis vs Jenkins | to be determined | June 24, 2018 | waiting more info | |||
JSON:API vs RAML | Some teams have introduced the usage of JSON:API (not RAML). Is that OK? | Mark Veksler | June 24, 2018 | Investigating request | ||
API Changes can break dependent modules | Anton Emelianov (Deactivated)'s 3rd observation was that there is no mechanism in place to guarantee API contracts aren't broken during upgrades/new builds. | Community, TC, PC |
| July 18, 2018 | TC to discuss | |
Once the Tech Council reviews the request and has enough information, if it is accepted into its current backlog the item will be moved into the Current Items table. If for some reason the TC decides to not pursue the request the decision will be documented in the following table.
Prior/Completed Backlog:
Item | Problem Statement/Background | Interested Parties | Requested Action | Original Request Date | Decision/Disposition | Completed Date |
---|---|---|---|---|---|---|
Establish process for engaging TC | The FOLIO community needs a method to engage the TC, make requests, solicit feedback, etc. | PC, Community | Create a process and document it. | June 14, 2018 | Page created. Wiki site updated. | July 9, 2018 |
Definition of FOLIO Platform/Core Apps | As the community evolves and other projects potentially start up, it makes sense to have a sturdy definition of what architectural aspects represent FOLIO's Platform, and which represent Core Applications. The Tech Council's role will (potentially) vary for each category, and new projects will benefit from clearly understanding what platform functionality exist and what functionality would need to be created as part of the application space. | PC, TC, Community, Future community members | Create a document. | TC | June 14, 2018 | July 18, 2018 |
Define an RFC Process | FOLIO needs a clearly defined RFC process that can be managed sustainably. To date key individuals and loose communication channels have been relied upon. As the project matures and the community grows, we need to establish formal processes. | PC, TC, Community | Create a document. | TC | June 14, 2018 | July 11, 2018 (pending publication of GitHub repository) |