chore: update files to compliant with layout_conventions
Some checks failed
Documentation Lint & Validation / Markdown Linting (push) Has been cancelled
Documentation Lint & Validation / Validate mdBook Configuration (push) Has been cancelled
Documentation Lint & Validation / Content & Structure Validation (push) Has been cancelled
mdBook Build & Deploy / Build mdBook (push) Has been cancelled
Rust CI / Security Audit (push) Has been cancelled
Rust CI / Check + Test + Lint (nightly) (push) Has been cancelled
Rust CI / Check + Test + Lint (stable) (push) Has been cancelled
Documentation Lint & Validation / Lint & Validation Summary (push) Has been cancelled
mdBook Build & Deploy / Documentation Quality Check (push) Has been cancelled
mdBook Build & Deploy / Deploy to GitHub Pages (push) Has been cancelled
mdBook Build & Deploy / Notification (push) Has been cancelled

This commit is contained in:
Jesús Pérez 2026-01-24 02:22:48 +00:00
parent 7b60982444
commit 2227e89122
Signed by: jesus
GPG Key ID: 9F243E355E0BC939
8 changed files with 25 additions and 25 deletions

View File

@ -23,9 +23,9 @@
- [ ] Test with `git push origin main` to docs/ - [ ] Test with `git push origin main` to docs/
### Documentation Files Created ### Documentation Files Created
- [x] `docs/MDBOOK_SETUP.md` — mdBook setup guide - [x] `docs/mdbook-setup.md` — mdBook setup guide
- [x] `docs/GITHUB_ACTIONS_SETUP.md` — Complete workflow documentation - [x] `docs/github-actions-setup.md` — Complete workflow documentation
- [x] `docs/DEPLOYMENT_GUIDE.md` — Deployment procedures - [x] `docs/deployment-guide.md` — Deployment procedures
- [x] `.github/WORKFLOWS.md` — Quick reference for developers - [x] `.github/WORKFLOWS.md` — Quick reference for developers
## 🚀 Initial Deployment Test ## 🚀 Initial Deployment Test
@ -114,7 +114,7 @@ git push origin main
### Team Notification ### Team Notification
- [ ] Announce workflows to team - [ ] Announce workflows to team
- [ ] Share `.github/WORKFLOWS.md` quick reference - [ ] 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 - [ ] Schedule documentation training if needed
## 🔄 Operational Procedures ## 🔄 Operational Procedures

View File

@ -236,7 +236,7 @@ All pass → ✅ Build successful
--- ---
For detailed configuration, see: For detailed configuration, see:
- `docs/GITHUB_ACTIONS_SETUP.md` - `docs/github-actions-setup.md`
- `.github/workflows/mdbook-build-deploy.yml` - `.github/workflows/mdbook-build-deploy.yml`
- `.github/workflows/docs-lint.yml` - `.github/workflows/docs-lint.yml`
- `.github/workflows/mdbook-publish.yml` - `.github/workflows/mdbook-publish.yml`

View File

@ -51,7 +51,7 @@ aws iam create-access-key --user-name vapora-docs-deployer
# 2. Create S3 bucket # 2. Create S3 bucket
aws s3 mb s3://vapora-docs --region us-east-1 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 # 4. Add GitHub secrets
# DOCS_DEPLOY_METHOD = s3 # DOCS_DEPLOY_METHOD = s3
@ -271,7 +271,7 @@ sudo tail -f /var/log/nginx/error.log
## Need Help? ## Need Help?
- Full guide: See `docs/CUSTOM_DEPLOYMENT_SERVER.md` - Full guide: See `docs/custom-deployment-server.md`
- Workflow reference: See `.github/WORKFLOWS.md` - Workflow reference: See `.github/WORKFLOWS.md`
- Deployment script: `.scripts/deploy-docs.sh` - Deployment script: `.scripts/deploy-docs.sh`
- GitHub Secrets: Repository → Settings → Secrets and variables → Actions - GitHub Secrets: Repository → Settings → Secrets and variables → Actions

View File

@ -27,7 +27,7 @@ Templates for:
### Documentation ### Documentation
**Files**: **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) - ✅ `.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 └── DEPLOYMENT_QUICK_START.md (Quick guide) ✨ New
docs/ docs/
├── MDBOOK_SETUP.md (mdBook guide) ├── mdbook-setup.md (mdBook guide)
├── GITHUB_ACTIONS_SETUP.md (Workflow details) ├── github-actions-setup.md (Workflow details)
├── DEPLOYMENT_GUIDE.md (Deployment reference) ├── deployment-guide.md (Deployment reference)
├── CUSTOM_DEPLOYMENT_SERVER.md (Complete setup) ✨ New ├── custom-deployment-server.md (Complete setup) ✨ New
└── CUSTOM_DEPLOYMENT_SETUP.md (This file) ✨ New └── custom-deployment-setup.md (This file) ✨ New
``` ```
--- ---
@ -434,11 +434,11 @@ bash .scripts/deploy-docs.sh production
| Topic | Location | | Topic | Location |
|-------|----------| |-------|----------|
| Quick Start | `.scripts/DEPLOYMENT_QUICK_START.md` | | 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` | | Workflow Details | `.github/WORKFLOWS.md` |
| Setup Checklist | `.github/CI_CD_CHECKLIST.md` | | Setup Checklist | `.github/CI_CD_CHECKLIST.md` |
| Deployment Script | `.scripts/deploy-docs.sh` | | 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.production`
- ✨ `.scripts/.deploy-config.staging` - ✨ `.scripts/.deploy-config.staging`
- ✨ `.scripts/DEPLOYMENT_QUICK_START.md` - ✨ `.scripts/DEPLOYMENT_QUICK_START.md`
- ✨ `docs/CUSTOM_DEPLOYMENT_SERVER.md` (45+ KB) - ✨ `docs/custom-deployment-server.md` (45+ KB)
- ✨ `docs/CUSTOM_DEPLOYMENT_SETUP.md` (This file) - ✨ `docs/custom-deployment-setup.md` (This file)
**Updated Files**: **Updated Files**:
- ✨ `.github/workflows/mdbook-publish.yml` (Enhanced with deployment integration) - ✨ `.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) 4. Test: Push docs/ change (automatic)
**Intermediate** (Want to understand): **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) 2. Read: `.github/WORKFLOWS.md` (10 min)
3. Setup: Full SSH deployment (20 min) 3. Setup: Full SSH deployment (20 min)
**Advanced** (Want all options): **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) 2. Study: `.scripts/deploy-docs.sh` (15 min)
3. Setup: Multiple deployment targets (60 min) 3. Setup: Multiple deployment targets (60 min)
@ -488,11 +488,11 @@ bash .scripts/deploy-docs.sh production
- Check: `.github/WORKFLOWS.md` - Check: `.github/WORKFLOWS.md`
**Detailed Setup**: **Detailed Setup**:
- Reference: `docs/CUSTOM_DEPLOYMENT_SERVER.md` - Reference: `docs/custom-deployment-server.md`
- Reference: `docs/DEPLOYMENT_GUIDE.md` - Reference: `docs/deployment-guide.md`
**Troubleshooting**: **Troubleshooting**:
- Check: `docs/CUSTOM_DEPLOYMENT_SERVER.md` → "Troubleshooting" - Check: `docs/custom-deployment-server.md` → "Troubleshooting"
- Check: `.github/CI_CD_CHECKLIST.md` → "Troubleshooting Reference" - Check: `.github/CI_CD_CHECKLIST.md` → "Troubleshooting Reference"
--- ---

View File

@ -477,8 +477,8 @@ git push origin main --tags
### Documentation ### Documentation
- `.github/WORKFLOWS.md` — Workflow quick reference - `.github/WORKFLOWS.md` — Workflow quick reference
- `docs/MDBOOK_SETUP.md` — mdBook setup guide - `docs/mdbook-setup.md` — mdBook setup guide
- `docs/GITHUB_ACTIONS_SETUP.md` — Full workflow documentation - `docs/github-actions-setup.md` — Full workflow documentation
- `docs/README.md` — Documentation standards - `docs/README.md` — Documentation standards
### External Resources ### External Resources

View File

@ -39,7 +39,7 @@ VAPORA documentation is now fully integrated with **mdBook**, a command-line too
``` ```
docs/ docs/
├── book.toml # mdBook configuration ├── book.toml # mdBook configuration
├── MDBOOK_SETUP.md # This file ├── mdbook-setup.md # This file
├── README.md # Main docs README (updated with mdBook info) ├── README.md # Main docs README (updated with mdBook info)
├── .gitignore # Excludes build artifacts ├── .gitignore # Excludes build artifacts