Skip to content

docs: add tutorial for db provisioning workflow#456

Draft
LakshanSS wants to merge 4 commits intoopenchoreo:mainfrom
LakshanSS:laki-aws-db
Draft

docs: add tutorial for db provisioning workflow#456
LakshanSS wants to merge 4 commits intoopenchoreo:mainfrom
LakshanSS:laki-aws-db

Conversation

@LakshanSS
Copy link
Copy Markdown
Contributor

Purpose

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 18, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e092e366-d21c-49f2-add0-fc2e3e7d6af6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation for self-service database provisioning workflows and updates the documentation site navigation and styling. It includes a new MDX guide explaining AWS RDS PostgreSQL provisioning via OpenChoreo, updates sidebar navigation, and adjusts the homepage hero component's heading level and styling.

Changes

Cohort / File(s) Summary
Database Provisioning Documentation
docs/use-cases/self-service-database-provisioning.mdx
New 386-line MDX documentation page detailing self-service AWS RDS PostgreSQL provisioning workflow, including prerequisites, IAM permissions, secret management, Terraform-based provisioning steps, state persistence, parameterization, and cleanup workflows.
Documentation Navigation
sidebars.ts
Added reference to new self-service database provisioning use-case page in the Tutorials category.
Homepage Hero Styling
src/components/HomepageHero/index.tsx, src/components/HomepageHero/styles.module.css
Changed hero tagline from h1 to h2 semantic heading; added margin-top to .heroTitle and standardized font-weight from string "bold" to numeric 700 in .heroTagline.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related issues

Possibly related PRs

  • chore: update ci docs #291: Documents workflow resource examples (ClusterWorkflowTemplate, Workflow, WorkflowRun) that align with the schema and patterns introduced in this DB provisioning guide.
  • feat: add cluster workflow docs #379: Related documentation updates for cluster-scoped workflow resources referenced in provisioning examples.
🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description includes the purpose and related issue, but lacks required checklist items for documentation updates (sidebars.ts, local preview, build verification, link verification). Include the complete checklist with verification status for all items: sidebars.ts update, npm run start, npm run build, and broken links verification.
Out of Scope Changes check ⚠️ Warning Changes include the requested database provisioning documentation, but also include unrelated changes to homepage hero component styling (heading level change and CSS updates) not mentioned in issue #2637. Remove out-of-scope changes to HomepageHero component and styles.module.css, or clarify their relationship to database provisioning workflow documentation.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding a tutorial for database provisioning workflow, which matches the primary objective in the linked issue #2637.
Linked Issues check ✅ Passed The pull request successfully implements the primary objective from issue #2637: creating a use-case document for database provisioning workflow based on the sample from issue #2395.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@LakshanSS LakshanSS marked this pull request as draft March 18, 2026 03:28
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/use-cases/self-service-database-provisioning.mdx`:
- Around line 1-386: The Prettier formatting check failed for the documentation
page "Self-Service Database Provisioning with Workflows"
(self-service-database-provisioning.mdx); run the repository formatter (e.g.,
the project's npm/yarn format script or prettier --write) against that MDX file,
commit the reformatting, and push to this branch so the CI Prettier check
passes; ensure you only change whitespace/formatting and do not alter content.
- Line 44: Update the sentence "An AWS account with an IAM user that has the
required permissions (see below)" to use “who” for the IAM user phrasing;
replace "that" with "who" so it reads "An AWS account with an IAM user who has
the required permissions (see below)". This is the only change needed in the
sentence text in the self-service provisioning documentation to improve natural
phrasing.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a8576535-eb15-47fe-a12b-14e3552d33ce

📥 Commits

Reviewing files that changed from the base of the PR and between 4552e94 and 2fd12a4.

📒 Files selected for processing (4)
  • docs/use-cases/self-service-database-provisioning.mdx
  • sidebars.ts
  • src/components/HomepageHero/index.tsx
  • src/components/HomepageHero/styles.module.css

@LakshanSS LakshanSS force-pushed the laki-aws-db branch 2 times, most recently from 6be7377 to e1e9341 Compare March 20, 2026 05:07
Signed-off-by: LakshanSS <lakshan230897@gmail.com>
Signed-off-by: LakshanSS <lakshan230897@gmail.com>
Signed-off-by: LakshanSS <lakshan230897@gmail.com>
Signed-off-by: LakshanSS <lakshan230897@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add usecase doc for db provisioning workflow

1 participant