Uploaded image for project: 'FOLIO'
  1. FOLIO
  2. FOLIO-1912

Aggregate metadata about RAMLs configuration from all RAML-based repos

    XMLWordPrintable

Details

    • New Feature
    • Status: Closed (View Workflow)
    • P3
    • Resolution: Duplicate
    • None
    • 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 FOLIO-1911, the generate-api-docs CI job assembles and deploys a summary metadata file to AWS S3 for that particular raml-based repository.

      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:
      The aggregated metadata file is published.

      Update: 2022-09-01 This is now handled by FOLIO-2922

      TestRail: Results

        Attachments

          Issue Links

            Activity

              People

                dcrossley David Crossley
                dcrossley David Crossley
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases