Documentation for the various components of FOLIO is in continuous development. Since the system is composed of many separate components, each component is documented individually. The best place to start is with the early chapters of the Okapi Guide and Reference, which describe the system as a whole and explain how the parts fit together.
In the context of those early chapters, you may then wish to go on to:
Community and contribution
The community section explains how to be involved, provides the contribution guidelines, lists the various collaboration tools and has some recommendations about when to use each.
The most important technical document is the Okapi Guide and Reference, which after the introductory sections already described, goes into detail about the Okapi API Gateway that controls a FOLIO system.
The FOLIO-Sample-Modules guide contains an explanation of FOLIO modules, a “getting started” guide, and some sample module code.
The Further reading section of that document contains links to other in-progress modules whose documentation may be of interest.
The FOLIO user-interface toolkit is called Stripes. It is described in the Stripes Core README, which leads to the related documentation.
Related to this, okapi-stripes describes a special Okapi module used to generate Stripes-based UIs for individual FOLIO tenants.
There is an early demonstration of Running a complete FOLIO system, using the Okapi Console front-end to deploy modules and see a list of users.
- The set of automatically generated API documentation.
Guidelines, tips, and best practice documents:
- Other community guidelines: Contribution; which communication forum; issue tracker; etc.
- A FOLIO glossary of some terms and technologies used in FOLIO.
- Some tips to assist developers to configure their local workstation setup.
- Some tips to assist developers to conduct troubleshooting.
- Use folio-ansible for a quick-start FOLIO installation as a virtual machine using Vagrant and Ansible.
- Best practices for Dockerfiles.
- The FOLIO build, test, and deployment infrastructure.
- A proposal for error response formats.