Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Tersely document requirements for an Okapi module

Description

As we start to build modules not based on RMB, such as mod-graphql – and as we start to see third-party modules arriving in potentially any language using any tools – we need to tersely and explicitly summarise what requirements a piece of software must meet to function as a FOLIO module.

The document that summarises this should probably be split into three sections:
1. What you need to do to run under Okapi.
2. What you need to do to run on Index Data/EBSCO CI.
3. Best practice (health-check WSAPIs, etc.)

(We are starting to think about a similar document for Stripes modules, too – see STCOR-180. This is good, healthy stuff: the kind of thing that fertilizes a diverse ecosystem.)

Environment

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:

(OLD ACCOUNT) Erin NettifeeJuly 7, 2023 at 1:19 PM

Additional things to consider adding, based off of DOCS-12 and the slack discussion here: https://folio-project.slack.com/archives/C210RP0T1/p1615211656064900

  • use of Java will get you more support from the community and more support from existing tooling;

  • if not using Java, language used in development must be able to be packaged as a Docker image;

Mike TaylorAugust 27, 2021 at 8:03 AM

That is encouraging indeed, !

jrootAugust 26, 2021 at 8:39 PM
Edited

, I'm hopeful the TC will start getting around to addressing these things more. We have a meeting in SysOps about this tomorrow in fact.

Mike TaylorAugust 24, 2021 at 12:23 AM

You know, it's getting really embarrassing that we still don't have this document, more than three months after the skeleton was created. It is arguably the single most important document that potential module creators need to read.

Mike TaylorFebruary 23, 2021 at 11:59 AM

Thanks to for adding the health-check endpoint to this document.

Details

Assignee

Reporter

Labels

Priority

Development Team

Core: Platform

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs

Created March 27, 2018 at 2:52 PM
Updated July 7, 2023 at 1:19 PM
TestRail: Cases
TestRail: Runs

Flag notifications