[FOLIO-1912] Aggregate metadata about RAMLs configuration from all RAML-based repos Created: 26/Mar/19 Updated: 01/Sep/22 Resolved: 01/Sep/22 |
|
| Status: | Closed |
| Project: | FOLIO |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | New Feature | Priority: | P3 |
| Reporter: | David Crossley | Assignee: | David Crossley |
| Resolution: | Duplicate | Votes: | 0 |
| Labels: | raml | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Issue links: |
|
||||||||||||||||||||||||
| Sprint: | |||||||||||||||||||||||||
| Development Team: | FOLIO DevOps | ||||||||||||||||||||||||
| Description |
|
The dev.folio.org website Jekyll Liquid code that generates the "Reference API documentation" tables needs to be efficient, so requires a pre-prepared up-to-date data file. Currently it uses the manually maintained api.yml data file. As explained in
Add a new Jenkins automation job, to regularly gather the metadata file for each repository, and then consolidate it into one single file. Publish this file so that it is available for Jekyll. Ideally it would be committed to the dev website source repository "_data" directory, where it can be automatically utilised by Jekyll Liquid. Otherwise it can be deployed to the top-level API docs space on AWS S3. Then an additional facility would be required by our Jekyll to retrieve that data file, at website generation time. This would require developing a Jekyll plugin for custom Liquid Tags (a small Ruby script). Acceptance criteria: Update: 2022-09-01 This is now handled by
|