Skip to content

Add Prebuilt Integrations to quick start guide - #587

Open
itsvishwa wants to merge 5 commits into
wso2:mainfrom
itsvishwa:docs/prebuilt-docs
Open

Add Prebuilt Integrations to quick start guide#587
itsvishwa wants to merge 5 commits into
wso2:mainfrom
itsvishwa:docs/prebuilt-docs

Conversation

@itsvishwa

@itsvishwa itsvishwa commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Purpose

New and evaluating users have no guided path to deploy a common integration without building it from scratch, which slows time-to-value for standard use cases like syncing Salesforce data to Google Sheets.

Goals

Add a documentation that walks users through picking, configuring, and deploying a prebuilt integration from the WSO2 Cloud catalog.

Resolves https://github.com/wso2-enterprise/integration-engineering/issues/1920

Summary by CodeRabbit

  • Documentation
    • Added a new “Prebuilt Integrations” guide for deploying production-ready prebuilt integrations on WSO2 Cloud.
    • Clarified the difference between sample and prebuilt integrations.
    • Added a guided walkthrough to browse the catalog, select applications and an integration scenario, review setup/credentials, deploy, test execution, and verify results.
    • Included steps to customize integrations using the cloud editor or locally in WSO2 Integrator IDE.
    • Updated navigation to include the guide under Get Started → Quick Starts.

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 2f581270-0a96-4f91-a39e-34b3b40e5569

📥 Commits

Reviewing files that changed from the base of the PR and between e3cf228 and e5ca1b7.

📒 Files selected for processing (1)
  • en/docs/get-started/prebuilt-integrations.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • en/docs/get-started/prebuilt-integrations.md

📝 Walkthrough

Walkthrough

Adds a “Prebuilt Integrations” documentation page covering discovery, deployment, testing, customization, and related resources, then adds it to the Get Started → Quick Starts sidebar.

Changes

Prebuilt Integrations Documentation

Layer / File(s) Summary
Prebuilt Integrations guide
en/docs/get-started/prebuilt-integrations.md
Adds page metadata and documents prebuilt integrations, catalog discovery, a seven-step workflow, customization options, callouts, and related resources.
Quick Starts navigation
en/sidebars.ts
Adds the new guide to the Get Started → Quick Starts navigation.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: rosensilva, anupama-pathirage, kavinduzoysa, nipunaranasinghe

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description includes Purpose and Goals, but most required template sections like Approach, Release note, tests, and docs are missing. Add the missing template sections, especially Approach, Release note, Documentation, tests, security checks, and the remaining required fields.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding a quick start guide for prebuilt integrations.
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

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.

@itsvishwa
itsvishwa requested a review from pcnfernando July 13, 2026 08:10
@github-actions

Copy link
Copy Markdown

Broken links, images & orphan pages

Passing — no broken links or images found.

Links/images come from one crawl of the production build (baseUrl-aware). Orphans are docs not referenced by sidebars.ts.

Summary

  • Broken links & images — total 0 · 🆕 introduced 0 · 📄 already on main 0
  • Orphan pages — total 8 · 🆕 introduced 0 · 📄 already on main 8

Broken links & images

Introduced by this PR

No new broken link(s)/image(s) introduced by this PR. ✅

Already on main — 0 total

None.

Orphan pages

Introduced by this PR

No new orphan page(s) introduced by this PR. ✅

Already on main — 8 total

Already present on the base branch (not caused by this PR):

Show 8
  • docs/deploy-operate/observe/datadog-integration
  • docs/deploy-operate/observe/elastic-stack-elk
  • docs/deploy-operate/observe/metrics-prometheus-grafana
  • docs/deploy-operate/observe/opensearch-integration
  • docs/deploy-operate/observe/recipe-elk-stack
  • docs/deploy-operate/observe/recipe-kubernetes-production
  • docs/deploy-operate/observe/recipe-local-development
  • docs/deploy-operate/observe/recipe-opensearch-setup


## Step 2: Pick the first application

Choose the application you want to integrate from. The catalog currently covers ten applications: Salesforce, Google Sheets, Shopify, Stripe, Google Chat, GitHub, Slack, Mailchimp, Jira, and QuickBooks. For this demonstration, select **Salesforce**.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We don't need to mention the count. Count can grow


## Step 7: Make it yours

To customize the integration, go to the overview page. Select **Open in Cloud** to edit the integration in low-code or pro-code view, right in the cloud editor. Or select **Open in Integrator** to edit the project locally in WSO2 Integrator IDE instead. Edit however you're most comfortable, then push the result to your own repository. At that point, it's fully yours, the same as any integration you built from scratch.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Edit the prebuilt integration. Not the project

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a new “Prebuilt Integrations” quick start that guides new/evaluating users through selecting, configuring, and deploying a catalog integration in WSO2 Cloud, improving time-to-value for common cross-application scenarios.

Changes:

  • Added a new quick start doc: Prebuilt Integrations (end-to-end walkthrough including prerequisites, deployment, testing, and customization).
  • Updated the Get Started → Quick Starts sidebar to include the new guide.

Reviewed changes

Copilot reviewed 2 out of 11 changed files in this pull request and generated no comments.

File Description
en/sidebars.ts Adds the new quick start doc entry under Get Started → Quick Starts.
en/docs/get-started/prebuilt-integrations.md New quick start documentation page for deploying and customizing prebuilt integrations from the WSO2 Cloud catalog.

Comment thread en/docs/get-started/prebuilt-integrations.md Outdated
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.

3 participants