From 2227e891223f3940f0191ab3773a04b0d9b23bbd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jesu=CC=81s=20Pe=CC=81rez?= Date: Sat, 24 Jan 2026 02:22:48 +0000 Subject: [PATCH] chore: update files to compliant with layout_conventions --- .github/ci_cd_checklist.md | 8 ++--- .github/workflows.md | 2 +- .scripts/deployment_quick_start.md | 4 +-- ..._SERVER.md => custom-deployment-server.md} | 0 ...NT_SETUP.md => custom-deployment-setup.md} | 30 +++++++++---------- ...EPLOYMENT_GUIDE.md => deployment-guide.md} | 4 +-- ...TIONS_SETUP.md => github-actions-setup.md} | 0 docs/{MDBOOK_SETUP.md => mdbook-setup.md} | 2 +- 8 files changed, 25 insertions(+), 25 deletions(-) rename docs/{CUSTOM_DEPLOYMENT_SERVER.md => custom-deployment-server.md} (100%) rename docs/{CUSTOM_DEPLOYMENT_SETUP.md => custom-deployment-setup.md} (93%) rename docs/{DEPLOYMENT_GUIDE.md => deployment-guide.md} (98%) rename docs/{GITHUB_ACTIONS_SETUP.md => github-actions-setup.md} (100%) rename docs/{MDBOOK_SETUP.md => mdbook-setup.md} (99%) diff --git a/.github/ci_cd_checklist.md b/.github/ci_cd_checklist.md index ac2372c..30ee947 100644 --- a/.github/ci_cd_checklist.md +++ b/.github/ci_cd_checklist.md @@ -23,9 +23,9 @@ - [ ] Test with `git push origin main` to docs/ ### Documentation Files Created -- [x] `docs/MDBOOK_SETUP.md` — mdBook setup guide -- [x] `docs/GITHUB_ACTIONS_SETUP.md` — Complete workflow documentation -- [x] `docs/DEPLOYMENT_GUIDE.md` — Deployment procedures +- [x] `docs/mdbook-setup.md` — mdBook setup guide +- [x] `docs/github-actions-setup.md` — Complete workflow documentation +- [x] `docs/deployment-guide.md` — Deployment procedures - [x] `.github/WORKFLOWS.md` — Quick reference for developers ## 🚀 Initial Deployment Test @@ -114,7 +114,7 @@ git push origin main ### Team Notification - [ ] Announce workflows to team - [ ] Share `.github/WORKFLOWS.md` quick reference -- [ ] Point to `docs/DEPLOYMENT_GUIDE.md` for deployment info +- [ ] Point to `docs/deployment-guide.md` for deployment info - [ ] Schedule documentation training if needed ## 🔄 Operational Procedures diff --git a/.github/workflows.md b/.github/workflows.md index 08ca5b8..02ed6c0 100644 --- a/.github/workflows.md +++ b/.github/workflows.md @@ -236,7 +236,7 @@ All pass → ✅ Build successful --- For detailed configuration, see: -- `docs/GITHUB_ACTIONS_SETUP.md` +- `docs/github-actions-setup.md` - `.github/workflows/mdbook-build-deploy.yml` - `.github/workflows/docs-lint.yml` - `.github/workflows/mdbook-publish.yml` diff --git a/.scripts/deployment_quick_start.md b/.scripts/deployment_quick_start.md index 00bc018..b491821 100644 --- a/.scripts/deployment_quick_start.md +++ b/.scripts/deployment_quick_start.md @@ -51,7 +51,7 @@ aws iam create-access-key --user-name vapora-docs-deployer # 2. Create S3 bucket aws s3 mb s3://vapora-docs --region us-east-1 -# 3. Attach policy (copy from docs/CUSTOM_DEPLOYMENT_SERVER.md) +# 3. Attach policy (copy from docs/custom-deployment-server.md) # 4. Add GitHub secrets # DOCS_DEPLOY_METHOD = s3 @@ -271,7 +271,7 @@ sudo tail -f /var/log/nginx/error.log ## Need Help? -- Full guide: See `docs/CUSTOM_DEPLOYMENT_SERVER.md` +- Full guide: See `docs/custom-deployment-server.md` - Workflow reference: See `.github/WORKFLOWS.md` - Deployment script: `.scripts/deploy-docs.sh` - GitHub Secrets: Repository → Settings → Secrets and variables → Actions diff --git a/docs/CUSTOM_DEPLOYMENT_SERVER.md b/docs/custom-deployment-server.md similarity index 100% rename from docs/CUSTOM_DEPLOYMENT_SERVER.md rename to docs/custom-deployment-server.md diff --git a/docs/CUSTOM_DEPLOYMENT_SETUP.md b/docs/custom-deployment-setup.md similarity index 93% rename from docs/CUSTOM_DEPLOYMENT_SETUP.md rename to docs/custom-deployment-setup.md index fd6a087..23bab92 100644 --- a/docs/CUSTOM_DEPLOYMENT_SETUP.md +++ b/docs/custom-deployment-setup.md @@ -27,7 +27,7 @@ Templates for: ### Documentation **Files**: -- ✅ `docs/CUSTOM_DEPLOYMENT_SERVER.md` — Complete reference (45+ KB) +- ✅ `docs/custom-deployment-server.md` — Complete reference (45+ KB) - ✅ `.scripts/DEPLOYMENT_QUICK_START.md` — Quick start guide (5 min setup) --- @@ -187,11 +187,11 @@ mdBook Publish & Sync Workflow (triggered) └── DEPLOYMENT_QUICK_START.md (Quick guide) ✨ New docs/ -├── MDBOOK_SETUP.md (mdBook guide) -├── GITHUB_ACTIONS_SETUP.md (Workflow details) -├── DEPLOYMENT_GUIDE.md (Deployment reference) -├── CUSTOM_DEPLOYMENT_SERVER.md (Complete setup) ✨ New -└── CUSTOM_DEPLOYMENT_SETUP.md (This file) ✨ New +├── mdbook-setup.md (mdBook guide) +├── github-actions-setup.md (Workflow details) +├── deployment-guide.md (Deployment reference) +├── custom-deployment-server.md (Complete setup) ✨ New +└── custom-deployment-setup.md (This file) ✨ New ``` --- @@ -434,11 +434,11 @@ bash .scripts/deploy-docs.sh production | Topic | Location | |-------|----------| | Quick Start | `.scripts/DEPLOYMENT_QUICK_START.md` | -| Full Reference | `docs/CUSTOM_DEPLOYMENT_SERVER.md` | +| Full Reference | `docs/custom-deployment-server.md` | | Workflow Details | `.github/WORKFLOWS.md` | | Setup Checklist | `.github/CI_CD_CHECKLIST.md` | | Deployment Script | `.scripts/deploy-docs.sh` | -| mdBook Guide | `docs/MDBOOK_SETUP.md` | +| mdBook Guide | `docs/mdbook-setup.md` | --- @@ -451,8 +451,8 @@ bash .scripts/deploy-docs.sh production - ✨ `.scripts/.deploy-config.production` - ✨ `.scripts/.deploy-config.staging` - ✨ `.scripts/DEPLOYMENT_QUICK_START.md` -- ✨ `docs/CUSTOM_DEPLOYMENT_SERVER.md` (45+ KB) -- ✨ `docs/CUSTOM_DEPLOYMENT_SETUP.md` (This file) +- ✨ `docs/custom-deployment-server.md` (45+ KB) +- ✨ `docs/custom-deployment-setup.md` (This file) **Updated Files**: - ✨ `.github/workflows/mdbook-publish.yml` (Enhanced with deployment integration) @@ -470,12 +470,12 @@ bash .scripts/deploy-docs.sh production 4. Test: Push docs/ change (automatic) **Intermediate** (Want to understand): -1. Read: `docs/GITHUB_ACTIONS_SETUP.md` (15 min) +1. Read: `docs/github-actions-setup.md` (15 min) 2. Read: `.github/WORKFLOWS.md` (10 min) 3. Setup: Full SSH deployment (20 min) **Advanced** (Want all options): -1. Read: `docs/CUSTOM_DEPLOYMENT_SERVER.md` (30 min) +1. Read: `docs/custom-deployment-server.md` (30 min) 2. Study: `.scripts/deploy-docs.sh` (15 min) 3. Setup: Multiple deployment targets (60 min) @@ -488,11 +488,11 @@ bash .scripts/deploy-docs.sh production - Check: `.github/WORKFLOWS.md` **Detailed Setup**: -- Reference: `docs/CUSTOM_DEPLOYMENT_SERVER.md` -- Reference: `docs/DEPLOYMENT_GUIDE.md` +- Reference: `docs/custom-deployment-server.md` +- Reference: `docs/deployment-guide.md` **Troubleshooting**: -- Check: `docs/CUSTOM_DEPLOYMENT_SERVER.md` → "Troubleshooting" +- Check: `docs/custom-deployment-server.md` → "Troubleshooting" - Check: `.github/CI_CD_CHECKLIST.md` → "Troubleshooting Reference" --- diff --git a/docs/DEPLOYMENT_GUIDE.md b/docs/deployment-guide.md similarity index 98% rename from docs/DEPLOYMENT_GUIDE.md rename to docs/deployment-guide.md index 336863f..4258dc1 100644 --- a/docs/DEPLOYMENT_GUIDE.md +++ b/docs/deployment-guide.md @@ -477,8 +477,8 @@ git push origin main --tags ### Documentation - `.github/WORKFLOWS.md` — Workflow quick reference -- `docs/MDBOOK_SETUP.md` — mdBook setup guide -- `docs/GITHUB_ACTIONS_SETUP.md` — Full workflow documentation +- `docs/mdbook-setup.md` — mdBook setup guide +- `docs/github-actions-setup.md` — Full workflow documentation - `docs/README.md` — Documentation standards ### External Resources diff --git a/docs/GITHUB_ACTIONS_SETUP.md b/docs/github-actions-setup.md similarity index 100% rename from docs/GITHUB_ACTIONS_SETUP.md rename to docs/github-actions-setup.md diff --git a/docs/MDBOOK_SETUP.md b/docs/mdbook-setup.md similarity index 99% rename from docs/MDBOOK_SETUP.md rename to docs/mdbook-setup.md index 2ebaf0f..acfcf03 100644 --- a/docs/MDBOOK_SETUP.md +++ b/docs/mdbook-setup.md @@ -39,7 +39,7 @@ VAPORA documentation is now fully integrated with **mdBook**, a command-line too ``` docs/ ├── book.toml # mdBook configuration -├── MDBOOK_SETUP.md # This file +├── mdbook-setup.md # This file ├── README.md # Main docs README (updated with mdBook info) ├── .gitignore # Excludes build artifacts │