Skip to content

docs: Add comprehensive Quick Start Guide #25

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 2 commits into from
Mar 31, 2026
Merged

docs: Add comprehensive Quick Start Guide #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66e298b
docs: Add comprehensive Quick Start Guide
chadmf Mar 31, 2026
200430c
docs: Make Quick Start Guide more prominent in README
chadmf Mar 31, 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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# AAP with EDB Postgres Multi-Datacenter Architecture

> **🚀 NEW: [Quick Start Guide](docs/quick-start-guide.md)** - Deploy in 15-30 minutes
> Choose your path: [OpenShift (15 min)](docs/quick-start-guide.md#quick-start-openshift-15-minutes) | [RHEL with TPA (20 min)](docs/quick-start-guide.md#quick-start-rhel-with-tpa-20-minutes) | [Local CRC (30 min)](docs/quick-start-guide.md#quick-start-local-testing-with-crc-30-minutes)

**📚 [Complete Documentation Index](docs/INDEX.md)** - Navigate all documentation by topic, deployment type, or audience

## Table of Contents
Expand Down
12 changes: 9 additions & 3 deletions docs/INDEX.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,15 @@

**New to this repository?** Start here:

1. **[Main README](../README.md)** - Architecture overview and table of contents
2. **[Deployment Guides](#deployment-guides)** - Choose your deployment method
3. **[DR Testing Guide](dr-testing-guide.md)** - Complete testing framework
1. **[Quick Start Guide](quick-start-guide.md)** ⭐ **START HERE** - Get running in 15-30 minutes
2. **[Main README](../README.md)** - Architecture overview and table of contents
3. **[Deployment Guides](#deployment-guides)** - Detailed deployment methods
4. **[DR Testing Guide](dr-testing-guide.md)** - Complete testing framework

**Quick deployment paths:**
- **OpenShift (15 min):** [Quick Start Guide - OpenShift](quick-start-guide.md#quick-start-openshift-15-minutes)
- **RHEL with TPA (20 min):** [Quick Start Guide - RHEL](quick-start-guide.md#quick-start-rhel-with-tpa-20-minutes)
- **Local testing (30 min):** [Quick Start Guide - CRC](quick-start-guide.md#quick-start-local-testing-with-crc-30-minutes)

**Need to perform a DR drill?**
- **[DR Testing Guide](dr-testing-guide.md)** - Complete testing framework
Expand Down
Loading
Loading