Add sqlserver related docs#306
Conversation
📝 WalkthroughThis update adds SQL Server documentation support across the API Gateway docs.
WalkthroughThe docs now describe Gateway Controller high availability and storage as using a shared external database that can be PostgreSQL or SQL Server. The database configuration guide adds PostgreSQL and SQL Server setup instructions, shared secret names, Helm values, and DSN-based examples. The deployment and storage pages update their wording and examples to match the broader database support. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/api-gateway/setup/storage-and-backends.md`:
- Line 17: The heading hierarchy is skipping a level in the storage-and-backends
document: the section currently uses an h3 for External Database (Gateway
Controller) directly under the page title. Update that section heading in the
markdown to match the previous h2 level and keep the document structure
consistent, using the existing External Database (Gateway Controller) heading
text in place of the current one.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2e87c57e-cbfc-4180-a747-914327e27f36
📒 Files selected for processing (5)
en/docs/api-gateway/deployment/deployment-modes/kubernetes/overview.mden/docs/api-gateway/deployment/high-availability-production-deployment.mden/docs/api-gateway/deployment/production-deployment/database-configuration.mden/docs/api-gateway/overview.mden/docs/api-gateway/setup/storage-and-backends.md
| # Configuring External Storage and Backends | ||
|
|
||
| ### PostgreSQL (Gateway Controller) | ||
| ### External Database (Gateway Controller) |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix heading hierarchy violation.
Line 17 uses ### External Database (Gateway Controller) (h3) immediately after the h1 title with no intervening h2. This skips a heading level and breaks document structure. Based on the change summary, this section replaced a previous ## PostgreSQL (Gateway Controller) heading. Restore this to ## External Database (Gateway Controller) to maintain proper heading increment.
📝 Proposed fix
-### External Database (Gateway Controller)
+## External Database (Gateway Controller)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### External Database (Gateway Controller) | |
| ## External Database (Gateway Controller) |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 17-17: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@en/docs/api-gateway/setup/storage-and-backends.md` at line 17, The heading
hierarchy is skipping a level in the storage-and-backends document: the section
currently uses an h3 for External Database (Gateway Controller) directly under
the page title. Update that section heading in the markdown to match the
previous h2 level and keep the document structure consistent, using the existing
External Database (Gateway Controller) heading text in place of the current one.
Purpose
Checklist
llms.txt(located aten/docs/llms.txt) is updated for AI readiness content.Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning