Skip to content

Add sqlserver related docs#306

Open
AnuGayan wants to merge 1 commit into
mainfrom
sqlserver-docs
Open

Add sqlserver related docs#306
AnuGayan wants to merge 1 commit into
mainfrom
sqlserver-docs

Conversation

@AnuGayan

@AnuGayan AnuGayan commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Purpose

Add Sql Server related docs

Checklist

  • Verified that llms.txt (located at en/docs/llms.txt) is updated for AI readiness content.
  • Ensured meaningful alt text for images and that the information contained in an image also appears in text so the relevant info exists in the body of the document.
  • Added or updated frontmatter for the respective pages.

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

This update adds SQL Server documentation support across the API Gateway docs.

  • Expanded high-availability and production deployment guidance to describe shared external database usage for both PostgreSQL and SQL Server.
  • Generalized database configuration docs to cover PostgreSQL and SQL Server side by side, including setup, Helm values, and DSN-based configuration examples.
  • Updated storage/backend guidance to include SQL Server configuration alongside the existing PostgreSQL examples.
  • Refined overview and deployment pages to align wording and front matter with the new database options.

Walkthrough

The 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)

Check name Status Explanation Resolution
Description check ⚠️ Warning The template is present, but most sections are left as placeholders and lack the required implementation details. Replace placeholders with concrete content for Goals, Approach, Release note, Documentation, Testing, and other required sections.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the changeset and clearly indicates SQL Server documentation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch sqlserver-docs

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between cd2409b and 05a7056.

📒 Files selected for processing (5)
  • en/docs/api-gateway/deployment/deployment-modes/kubernetes/overview.md
  • en/docs/api-gateway/deployment/high-availability-production-deployment.md
  • en/docs/api-gateway/deployment/production-deployment/database-configuration.md
  • en/docs/api-gateway/overview.md
  • en/docs/api-gateway/setup/storage-and-backends.md

# Configuring External Storage and Backends

### PostgreSQL (Gateway Controller)
### External Database (Gateway Controller)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 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.

Suggested change
### 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.

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.

2 participants