Skip to content

docs: Reorganize scripts documentation with comprehensive guides #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chadmf merged 7 commits into from
Apr 3, 2026
Merged

docs: Reorganize scripts documentation with comprehensive guides #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0880516
docs: Add HAProxy architecture analysis for EDB PostgreSQL routing
chadmf Apr 2, 2026
d335227
fix: Update .gitignore to exclude all .pub files
chadmf Apr 2, 2026
7af8aff
test: Add PostgreSQL replication test results and configuration
chadmf Apr 3, 2026
abe45b7
docs: Reorganize scripts documentation with comprehensive guides
chadmf Apr 3, 2026
da4148c
Merge branch 'main' into scripts-update
chadmf Apr 3, 2026
3d0d039
fix: Correct regex escaping in password validation
chadmf Apr 3, 2026
15dd5a9
fix: Remove invalid 'local' keyword usage outside functions
chadmf Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@
*.tmp
*.bak
.DS_Store
.pub
*.pub
4 changes: 2 additions & 2 deletions aap-deploy/openshift/scripts/deploy-aap-lab-external-pg.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ if [[ "${SKIP_DB_BOOTSTRAP:-}" != "1" ]]; then
echo "==> Bootstrapping AAP databases (role + DBs + hstore)..."

# Validate password doesn't contain SQL metacharacters
if [[ "$AAP_DB_PASSWORD" =~ [\'\"\\;] ]]; then
echo "error: AAP_DB_PASSWORD contains forbidden characters: ', \", \\, or ;" >&2
if [[ "$AAP_DB_PASSWORD" =~ [\'\"\;] ]]; then
echo "error: AAP_DB_PASSWORD contains forbidden characters: ', \", or ;" >&2
echo "These characters could cause SQL injection or parsing errors" >&2
exit 1
fi
Expand Down
14 changes: 11 additions & 3 deletions docs/INDEX.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,11 @@ Choose based on your requirements:
| **[generate-dr-report.sh](../scripts/generate-dr-report.sh)** | DR test report generation | `./generate-dr-report.sh <test-id>` |

**Script Documentation:**
- [Scripts README](../scripts/README.md) - Detailed usage for all scripts
- [Manual Scripts Doc](manual-scripts-doc.md) - Operations runbook
- **[Scripts README](../scripts/README.md)** ⭐ - Quick reference for all scripts
- **[Scripts Guide](scripts-guide.md)** - Comprehensive usage guide
- **[Scripts Library Reference](scripts-library-reference.md)** - Shared library functions API
- **[Scripts Hooks and CI/CD](scripts-hooks-and-cicd.md)** - Pre-commit hooks and quality automation
- **[Manual Scripts Doc](manual-scripts-doc.md)** - Operations runbook

---

Expand All @@ -158,6 +161,7 @@ Choose based on your requirements:
**Contributing and automation:**

- **[CI/CD Pipeline](cicd-pipeline.md)** - GitHub Actions workflows (6,500 words)
- **[Scripts Hooks and CI/CD](scripts-hooks-and-cicd.md)** ⭐ **NEW** - Pre-commit hooks, CI checks, and quality automation
- **[Pre-commit Hooks](../.pre-commit-config.yaml)** - Local validation before commit
- **CONTRIBUTING.md** - _Coming soon_ (see [Documentation Audit](documentation-audit-report.md))

Expand All @@ -169,6 +173,7 @@ Choose based on your requirements:
**Testing:**
- [Component Testing Results](component-testing-results.md) - Script validation (macOS/CRC)
- [AAP Deployment Validation](aap-deployment-validation-crc.md) - End-to-end validation
- [run-ci-checks-locally.sh](../scripts/run-ci-checks-locally.sh) - Run CI checks before pushing

---

Expand Down Expand Up @@ -296,7 +301,7 @@ Choose based on your requirements:
| ⚠️ Partial | 4 | Exists but needs expansion (security, monitoring) |
| ❌ Planned | 3 | Identified in audit, not yet created (GLOSSARY, FAQ, Migration Guide) |

**Recent Additions (2026-03-31):**
**Recent Additions (2026-03-31 to 2026-04-03):**
- ✅ DR Testing Guide (10,000+ words)
- ✅ DR Testing Implementation Summary
- ✅ Component Testing Results
Expand All @@ -305,6 +310,9 @@ Choose based on your requirements:
- ✅ Documentation Audit Report
- ✅ Documentation Index (this file)
- ✅ Contributing Guide (CONTRIBUTING.md)
- ✅ Scripts Library Reference (2026-04-03)
- ✅ Scripts Hooks and CI/CD Guide (2026-04-03)
- ✅ Scripts README reorganization (2026-04-03)

**Next Documentation Priorities:**
1. Security Hardening Guide (Week 2)
Expand Down
Loading
Loading