🥁 Prelude

.gitignore

@@ -1 +1,5 @@
-.DS_Store
+.env
+.DS_Store
+node_modules
+__MACOSX
+dist

Makefile

@@ -1,20 +1,110 @@
-platform:
-	PROFILE=platform docker compose --profile platform up --attach conductor
+help:
+	@echo "================ Prelude Makefile Commands ================"
+	@echo ""
+	@echo "Conductor Development Environments:"
+	@echo "  phase1         - Start Phase 1 development environment"
+	@echo "  phase2         - Start Phase 2 development environment"
+	@echo "  phase3         - Start Phase 3 development environment"
+	@echo "  stage-dev      - Start Stage development environment"
+	@echo ""
+	@echo "Conductor Deployment:"
+	@echo "  pre-check      - Run pre-deployment checks"
+	@echo "  deploy-stage   - Deploy the stage application (with pre-checks)"
+	@echo ""
+	@echo "Conductor Data Loading and Management:"
+	@echo "  clean-data     - Remove all documents from Elasticsearch (preserves index structure)"
+	@echo ""
+	@echo "Conductor System Management:"
+	@echo "  down           - Gracefully shutdown all containers"
+	@echo "  reset          - DANGER: Remove all containers and volumes (DATA LOSS)"
+	@echo ""
+	@echo "Composer Configuration Generation:"
+	@echo "  generate-phase-one-configs      - Generate Phase One Configurations"
+	@echo "  generate-phase-two-configs      - Generate Phase Two Configurations"
+	@echo "  generate-phase-three-configs    - Generate Phase Three Configurations"
+	@echo ""
+	@echo "General Usage:"
+	@echo "  make help      - Show this help message"
+	@echo "  make <command> - Run a specific command"
+	@echo ""
+	@echo "==============================================================="
 
-stageDev:
-	PROFILE=stageDev docker compose --profile stageDev up --attach conductor
+# ================================================================================== #
+#                                    Conductor:                                      #
+# ================================================================================== #
 
-arrangerDev:
-	PROFILE=arrangerDev docker compose --profile arrangerDev up --attach conductor
+# Run pre-deployment checks
+phase0:
+	@echo "Running Pre-deployment checks..."
+	chmod +x ./apps/conductor/scripts/deployments/phase0.sh
+	./apps/conductor/scripts/deployments/phase0.sh
 
-maestroDev:
-	PROFILE=maestroDev docker compose --profile maestroDev up --attach conductor
+# Start Phase One development environment
+phase1:
+	@echo "Starting Phase 1 development environment..."
+	PROFILE=phase1 docker compose -f ./docker-compose.yml --profile phase1 up --attach conductor 
 
-songDev:
-	PROFILE=songDev docker compose --profile songDev up --attach conductor
+# Start Phase Two development environment
+phase2:
+	@echo "Starting Phase 2 development environment..."
+	PROFILE=phase2 docker compose -f ./docker-compose.yml --profile phase2 up --attach conductor
 
-scoreDev:
-	PROFILE=scoreDev docker compose --profile scoreDev up --attach conductor
+# Start Phase Three development environment
+phase3:
+	@echo "Starting Phase 3 development environment..."
+	PROFILE=phase3 docker compose -f ./docker-compose.yml --profile phase3 up --attach conductor 
 
+# Start Stage development environment
+stage-dev:
+	@echo "Starting Stage development environment..."
+	PROFILE=stageDev docker compose -f ./docker-compose.yml --profile stageDev up --attach conductor
+
+
+# Deploy the stage application (with pre-checks)
+deploy-stage: pre-check
+	@echo "Deploying stage application..."
+	docker build -t stageimage:1.0 .
+
+# Gracefully shutdown all containers while preserving volumes
 down:
-	PROFILE=platform docker compose --profile platform down
+	@echo "Shutting down all running containers..."
+	PROFILE=default docker compose -f ./docker-compose.yml --profile default down
+
+# Shutdown all containers and remove all volumes (WARNING: Deletes all data)
+reset:
+	@echo "\033[1;33mWarning:\033[0m This will remove all containers AND their volumes. Data will be lost."
+	@read -p "Are you sure you want to continue? [y/N] " confirm; \
+	if [ "$$confirm" = "y" ] || [ "$$confirm" = "Y" ]; then \
+		PROFILE=default docker compose -f ./docker-compose.yml --profile default down -v ; \
+	else \
+		echo "Operation cancelled"; \
+	fi
+
+# Remove all documents from Elasticsearch (preserves index structure)
+clean-data:
+	@echo "\033[1;33mWarning:\033[0m This will delete ALL data from the Elasticsearch index."
+	@read -p "Are you sure you want to continue? [y/N] " confirm; \
+	if [ "$$confirm" = "y" ] || [ "$$confirm" = "Y" ]; then \
+		PROFILE=clean docker compose -f ./docker-compose.yml --profile clean up --attach conductor; \
+	else \
+		echo "\033[1;36mOperation cancelled\033[0m"; \
+	fi
+
+# ================================================================================== #
+#                                    Composer:                                       #
+# ================================================================================== #
+
+# Generate Phase One Configurations 
+generate-phase-one-configs:
+	@echo "Generating Phase One Configurations..."
+	PROFILE=generatePhaseOneConfigs docker compose -f ./docker-composer.yml --profile generatePhaseOneConfigs up --attach composer
+
+# Generate Phase Two Configurations 
+generate-phase-two-configs:
+	@echo "Generating Phase Two Configurations..."
+	PROFILE=generatePhaseTwoConfigs docker compose -f ./docker-composer.yml --profile generatePhaseTwoConfigs up --attach composer
+
+# Generate Phase Three Configurations 
+generate-phase-three-configs:
+	@echo "Generating Phase Three Configurations..."
+	PROFILE=generatePhaseThreeConfigs docker compose -f ./docker-composer.yml --profile generatePhaseThreeConfigs up --attach composer

README.md

@@ -1,69 +1,142 @@
-# Conductor 
+# Overture Documentation Portal
 
-Conductor is a flexible Docker Compose setup that simplifies the process of spinning up Overture development and deployment configurations using Docker profiles and extensible scripting events.
+A comprehensive documentation portal for the Overture data platform implementation, built with Next.js and featuring a responsive, mobile-friendly design with intuitive navigation.
 
-## Key Features
+## Overview
 
-- **Profile-based Deployments**: Uses Docker profiles to manage different environment setups.
-- **Conductor-driven Execution**: The Conductor service executes ordered scripts based on the `PROFILE` environment variable.
+This documentation portal provides a structured, user-friendly interface for accessing Overture's Prelude documentation. It features:
+
+- Responsive sidebar navigation with mobile support
+- Markdown content rendering with automatic table of contents
+- Section-based navigation with previous/next links
+- Copy-to-clipboard functionality for headings
+- Dynamic content loading
 
 ## Getting Started
 
-**1. Clone the repo's `main` branch**
+### Prerequisites
 
-```
-git clone -b concerto https://github.com/overture-stack/composer.git && cd composer
+- **Docker Desktop 4.39.0+** with:
+  - 8-core CPU minimum
+  - 8 GB memory
+  - 2 GB swap
+  - 64 GB virtual disk
+- **Node.js 18+ and npm 9+**
+
+### First Steps
+
+Start by running the pre-deployment check to ensure your environment is properly configured:
+
+```bash
+make phase0
 ```
 
-**2. Run one of the following commands to spin up different environments:**
+This command will verify your system meets all requirements and provide guidance on any necessary adjustments.
 
-| Environment | Unix/macOS | Windows |
-|-------------|------------|---------|
-| Overture Platform | `make platform` | `make.bat platform` |
-| Stage Dev | `make stageDev` | `make.bat stageDev` |
-| Arranger Dev | `make arrangerDev` | `make.bat arrangerDev` |
-| Maestro Dev | `make maestroDev` | `make.bat maestroDev` |
-| Song Dev | `make songDev` | `make.bat songDev` |
-| Score Dev | `make scoreDev` | `make.bat scoreDev` |
+### Deployment Options
 
-Each command spins up complementary services for the specified development environment.
+The portal can be deployed in phases, with each phase adding additional functionality:
 
-## Repository Structure
+```bash
+# Deploy Phase 1: Data Exploration & Theming
+make phase1
 
+# Deploy Phase 2: Tabular Data Management
+make phase2
+
+# Deploy Phase 3: File Management
+make phase3
+
+# Run Stage in development mode
+make stage-dev
+
+# Reset all containers and volumes
+make reset
 ```
-.
-├── conductorScripts/
-│   ├── deployments
-│   └── services
-├── configurationFiles/
-│   ├── arrangerConfigs
-│   ├── elasticsearchConfigs
-│   └── keycloakConfigs
-├── guideMaterials
-├── persistentStorage/
-│   ├── data-keycloak-db
-│   ├── data-minio
-│   └── data-song-db
-├── Makefile
-└── make.bat
-```
 
-- **`conductorScripts/`** Contains scripts for orchestrating the deployment process.
-    - `deployments/`: Scripts that execute service scripts sequentially based on the deployment configuration. These also include custom post-deployment logs with essential next steps for the deployment scenario.
-    - `services/`: Modular scripts for individual service setup tasks. Each file is named according to its purpose, with inline comments documenting the code.
+### Accessing the Portal
+
+Once running, access the documentation portal at: [http://localhost:3000](http://localhost:3000)
+
+## Documentation Structure
 
-- **`configurationFiles/`** Stores all required configuration files, including:
-    - `arrangerConfigs/`: Configuration files specific to Arranger.
-    - `elasticsearchConfigs/`: Configuration files for Elasticsearch, encompassing indexing mappings and documents for seeding data.
-    - `keycloakConfigs/`: Configuration files for Keycloak, including preconfigured realm files and Overture API key provider details.
+The documentation is organized into phases matching the Prelude development workflow:
 
-- **`guideMaterials/`** Supplementary folders and files for use with the [Overture guides](https://www.overture.bio/documentation/guides/).
+- **Introduction**: Overview of the Prelude toolkit and its components
+- **Phase One**: Data Exploration & Theming (Elasticsearch, Arranger, Stage)
+- **Phase Two**: Tabular Data Management (Lyric, Lectern, Postgres, MongoDB)
+- **Phase Three**: File Management (Song, Score, Object Storage)
+- **Phase Four**: Identity & Access (Coming in future release)
+- **Support**: How to get help and contribute
 
-- **`persistentStorage/`** Directory for storing persistent data during container startups and restarts. These folders come pre-loaded with mock data.
-    - `data-keycloak-db/`: Persistent local storage for the Keycloak database.
-    - `data-minio/`: Persistent local storage for MinIO object storage.
-    - `data-song-db/`: Persistent local storage for the Song database.
+## Development
+
+### Local Development Environment
+
+To modify the documentation portal itself:
+
+1. Clone the repository
+2. Install dependencies:
+   ```bash
+   cd apps/stage
+   npm install
+   ```
+3. Run the development server:
+   ```bash
+   npm run dev
+   ```
+
+### Updating Documentation Content
+
+Documentation content is stored as Markdown files in the `public/docs` directory. To add or update content:
+
+1. Files are prefixed with numbers (`00-`, `01-`, etc.) to control ordering
+2. Each file should start with a top-level heading (`# Title`)
+3. Place images in `public/docs/images/`
+4. Use standard Markdown syntax for formatting
+
+## Project Structure
+
+The project follows a modular structure with two main applications: Conductor (for data management) and Stage (for the front-end portal).
+
+```
+├── apps/
+│   ├── composer/                 # Config generation tool
+│   │   └── src/                  # Source code
+│   │       ├── cli/              # CLI interface
+│   │       ├── commands/         # Command implementations
+│   │       ├── services/         # Core functions for config generation
+│   │       └── utils/            # Utility functions
+│   │
+│   ├── conductor/                # Data management tool
+│   │   ├── src/                  # Source code
+│   │   │   ├── cli/              # CLI interface
+│   │   │   ├── commands/         # Command implementations
+│   │   │   ├── services/         # Core services (ES, Lectern, etc.)
+│   │   │   └── utils/            # Utility functions
+│   │   ├── configs/              # Configuration files
+│   │   │   ├── arrangerConfigs/  # Arranger UI configurations
+│   │   │   ├── elasticsearchConfigs/ # Elasticsearch mappings
+│   │   │   ├── lecternDictionaries/ # Data dictionaries
+│   │   │   └── songSchemas/      # Song schemas
+│   │   └── scripts/              # Deployment and service scripts
+│   │       ├── deployments/      # Phase deployment scripts
+│   │       └── services/         # Service management scripts
+│   │
+│   └── stage/                    # Frontend portal
+│       ├── components/
+│       │   ├── pages/            # Page-specific components
+│       │   └── theme/            # Theming
+│       ├── pages/                # Next.js pages
+│       └── public/               # Static assets
+│           └── docs/             # Markdown documentation files
+│               └── images/       # Documentation images
+│
+├── configs/                      # Symlink to conductor configs
+├── data/                         # Data files
+└── docs/                         # Symlink to Stage docs
+```
 
-- **`Makefile`** Contains [`make` commands](https://www.gnu.org/software/make/manual/make.html#Overview-of-make) for Unix-based systems (macOS, Linux) to streamline Docker operations.
+## Support
 
-- **`make.bat`** Windows equivalent of the Makefile, featuring batch commands tailored for Windows systems.
+For assistance, reach out via the [community support channels](https://docs.overture.bio/community/support), for private inquiries email us at [[email protected]](mailto:[email protected]).