From 80242b96022f95e791d507e10ffbc187e8d38b73 Mon Sep 17 00:00:00 2001 From: Mondo Diaz Date: Thu, 16 Oct 2025 17:23:03 -0500 Subject: [PATCH] Reorganize project structure: move docs and scripts to proper directories MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Changes: - Created scripts/ directory for build and utility scripts - Moved build-for-airgap.sh to scripts/ - Moved check-ready.sh to scripts/ - Kept quickstart scripts in root for easy access - Moved HELM-DEPLOYMENT.md to docs/ Updated references: - README.md: Updated link to docs/HELM-DEPLOYMENT.md - docs/DEPLOYMENT.md: Updated paths to scripts/build-for-airgap.sh - quickstart-airgap.sh: Updated path to scripts/build-for-airgap.sh - scripts/check-ready.sh: Updated self-reference path - helm/warehouse13/QUICKSTART.md: Updated HELM-DEPLOYMENT.md path - helm/README.md: Updated HELM-DEPLOYMENT.md path Directory structure now: / ├── README.md (root) ├── quickstart.sh (root - easy access) ├── quickstart-airgap.sh (root - easy access) ├── docs/ (all documentation) │ ├── API.md │ ├── ARCHITECTURE.md │ ├── DEPLOYMENT.md │ ├── FEATURES.md │ ├── FRONTEND_SETUP.md │ ├── HELM-DEPLOYMENT.md (moved here) │ └── SUMMARY.md ├── scripts/ (build and utility scripts) │ ├── build-for-airgap.sh (moved here) │ └── check-ready.sh (moved here) └── helm/ └── warehouse13/ (Helm chart with docs) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- README.md | 2 +- docs/DEPLOYMENT.md | 2 +- HELM-DEPLOYMENT.md => docs/HELM-DEPLOYMENT.md | 0 helm/README.md | 2 +- helm/warehouse13/QUICKSTART.md | 2 +- quickstart-airgap.sh | 2 +- build-for-airgap.sh => scripts/build-for-airgap.sh | 0 check-ready.sh => scripts/check-ready.sh | 2 +- 8 files changed, 6 insertions(+), 6 deletions(-) rename HELM-DEPLOYMENT.md => docs/HELM-DEPLOYMENT.md (100%) rename build-for-airgap.sh => scripts/build-for-airgap.sh (100%) rename check-ready.sh => scripts/check-ready.sh (97%) diff --git a/README.md b/README.md index 01d2202..62989a1 100644 --- a/README.md +++ b/README.md @@ -243,7 +243,7 @@ kubectl port-forward -n warehouse13 svc/warehouse13-api 8000:8000 ### Helm Documentation -- **Full Helm Guide:** [HELM-DEPLOYMENT.md](./HELM-DEPLOYMENT.md) +- **Full Helm Guide:** [HELM-DEPLOYMENT.md](./docs/HELM-DEPLOYMENT.md) - **Chart README:** [helm/warehouse13/README.md](./helm/warehouse13/README.md) - **Quick Start:** [helm/warehouse13/QUICKSTART.md](./helm/warehouse13/QUICKSTART.md) - **Example Configurations:** diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index f596b5e..2d27e12 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -54,7 +54,7 @@ This script will: ```bash # Option A: Use the helper script -./build-for-airgap.sh +./scripts/build-for-airgap.sh # Option B: Build manually cd frontend diff --git a/HELM-DEPLOYMENT.md b/docs/HELM-DEPLOYMENT.md similarity index 100% rename from HELM-DEPLOYMENT.md rename to docs/HELM-DEPLOYMENT.md diff --git a/helm/README.md b/helm/README.md index 9b35934..fed3a93 100644 --- a/helm/README.md +++ b/helm/README.md @@ -43,4 +43,4 @@ Note: Check your values.yaml configuration and update image repositories, resour ## Quick Start -See [../HELM-DEPLOYMENT.md](../HELM-DEPLOYMENT.md) for comprehensive deployment guide. +See [../docs/HELM-DEPLOYMENT.md](../docs/HELM-DEPLOYMENT.md) for comprehensive deployment guide. diff --git a/helm/warehouse13/QUICKSTART.md b/helm/warehouse13/QUICKSTART.md index b70e123..1d0cee9 100644 --- a/helm/warehouse13/QUICKSTART.md +++ b/helm/warehouse13/QUICKSTART.md @@ -118,7 +118,7 @@ kubectl delete namespace warehouse13 ## Next Steps - **Full Documentation:** [README.md](./README.md) -- **Deployment Guide:** [../../HELM-DEPLOYMENT.md](../../HELM-DEPLOYMENT.md) +- **Deployment Guide:** [../../docs/HELM-DEPLOYMENT.md](../../docs/HELM-DEPLOYMENT.md) - **Configuration Options:** [values.yaml](./values.yaml) - **Example Configs:** [values-dev.yaml](./values-dev.yaml), [values-production.yaml](./values-production.yaml), [values-airgapped.yaml](./values-airgapped.yaml) diff --git a/quickstart-airgap.sh b/quickstart-airgap.sh index 0f6097f..e52aade 100755 --- a/quickstart-airgap.sh +++ b/quickstart-airgap.sh @@ -30,7 +30,7 @@ fi echo "Step 1: Building Angular frontend locally..." echo "===========================================" -./build-for-airgap.sh +./scripts/build-for-airgap.sh echo "" echo "Step 2: Starting Docker containers..." diff --git a/build-for-airgap.sh b/scripts/build-for-airgap.sh similarity index 100% rename from build-for-airgap.sh rename to scripts/build-for-airgap.sh diff --git a/check-ready.sh b/scripts/check-ready.sh similarity index 97% rename from check-ready.sh rename to scripts/check-ready.sh index 6f888b1..21ad278 100755 --- a/check-ready.sh +++ b/scripts/check-ready.sh @@ -18,7 +18,7 @@ else echo " Expected: frontend/dist/frontend/browser" echo "" echo " You need to build the Angular app first:" - echo " Run: ./build-for-airgap.sh" + echo " Run: ./scripts/build-for-airgap.sh" echo " OR: cd frontend && npm install && npm run build:prod" echo "" errors=$((errors + 1))