🥁 Prelude

[MitchellShiell]

Prelude is a tool that enables teams to incrementally build their data platform. By breaking down data portal development into phased steps, teams can systematically verify requirements and user workflows while minimizing technical overhead.

Development Phases

Development progresses through four distinct phases, each building upon the
previous phase's foundation while introducing new capabilities.

Phase	Description	Software Components	Status
PhaseOne: Data Exploration & Theming	Display your tabular data in a themable portal with our front-end and back-end search components.	CSV-processor, Elasticsearch, Arranger, Stage	🟢 Working
PhaseTwo: Tabular Data Management & Validation	Implementation of tabular data submission, storage and validation.	All the above with Lyric, LyricDb (Postgres), Lectern and LecternDb (MongoDb) added	🟢 Working
PhaseThree: File Data & Metadata Management	Implement back-end file management.	All the above with Song, Score, SongDb (Postgres) and Object Storage (Minio)	🟢 Working
PhaseFour: Identity and Access management	Configure Keycloak to authenticate users and authorize what they have access too.	Empahsis on data access control planning and Keycloak configuration	⚪ For Next Release

Documentation

Detailed documentation can be found in multiple locations:

• The /docs folder at the root of this repository and within the docker-compose.yml
• README files within each root directory containing information on the folder's
  purpose and usage
• Frontend documentation available after deployment at
  http://localhost:3000/documentation

Next Steps

• Update Conductor Repo to Prelude
  • Copy Main branch to a branch called quickstart
  • Update all documentation references accordingly
  • Merge Prelude to Main

@justincorrigible Submodule documentation PR Updates

• Prelude update arranger#935
• Prelude update stage#219
• docker version SONG#882
• docker version maestro#290
• docker version + naming score#489

@justincorrigible Score needs to be merged and is blocked by jenkins

• Score Dev Documentation  score#482

Note

Prelude will eventually merge with the quickstart as an all in one however this will require the keycloak update as well as significant updates to the current guides on docs.overture.bio. Due to this it will be taken on following phase 4 development, for now to avoid confusion we will replace any mention of conductor with quickstart and update this repo name to prelude.

• Update docs.overture.bio
  • Prelude, Quickstart & Docs updates + docker version #'s docs#27
• Update overture.bio
  • Conductor > Quickstart website#415
• Add documentation on adding data tables
• Add documentation on theming the portal

Note

Eventually the documentation within the docs folder here will be published to docs.overture.bio similar to how every other repo works. This is pending updates that will align admonition syntax and title logic.

• Windows Run through (WSL2)

  • Phase0
  • Phase1
  • Phase2
  • Phase3

• Mac/Linux Run through

  • Phase0
  • Phase1
  • Phase2
  • Phase3

• Windows Updates

  • Symbolic links not cloning
  • Stage build step freezing