Add new guides for using connectors

[Sachindu-Nethmin]

Purpose

The objective of this PR is to provide a comprehensive guide on managing Connections within WSO2 Integrator: BI. Currently, users need clear documentation on how to securely connect integrations to external systems using various authentication methods and transport settings.

This PR addresses the need for:

• Defining reusable connection configurations.
• Documentation for the two primary workflows: creating connections before or during the integration design process.

Goals

This documentation update introduces the following:

• Pre-emptive Configuration: Guidance on setting up connections for known external systems like Salesforce or databases before starting a flow.
• In-flow Configuration: A step-by-step guide for creating and testing connections dynamically while building automation flows.

Approach

The implementation consists of a structured Markdown guide with integrated visual assets:

• Step-by-Step Instructions: Detailed walkthroughs for creating a project, configuring an HTTP connector, and using it in an automation flow.
• Visual Guides:
  • en/docs/assets/img/developer-guides/connectors/create-new-integration.gif
  • en/docs/assets/img/developer-guides/connectors/configure-http-connection.gif
  • en/docs/assets/img/developer-guides/connectors/use-connection-and-run.gif

Release note

Added a new developer guide for managing Connections in WSO2 Integrator: BI, featuring step-by-step instructions for pre-configuring and dynamically creating external system connectors.

Documentation

The changes are located in the developer guides section: en/docs/developer-guides/connectors/managing-connections.md.

Samples

Includes a sample automation project named connectors that demonstrates a GET request to a placeholder API using a custom-configured HTTP connection.

Test environment

• Operating System: Ubuntu (Linux)
• Tooling: VS Code with WSO2 Integrator: BI extension 1.6.0
• Ballerina Version: 2201.13.1 (Swan Lake Update 13)

Summary by CodeRabbit

• Documentation
  • Added a new user guide for using connectors in WSO2 Integrator: BI with step-by-step workflows.
  • Explains connection concepts (authentication, endpoints, transport) and reuse across integrations.
  • Shows creating connections before and during integration design, includes example configurations and sample API responses.
  • Includes visual aids and updates navigation to surface the new guide.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Adds a new developer guide "How To Use Connetors" describing connector concepts and step-by-step workflows for creating integrations and HTTP connections, plus a navigation entry in the site config linking the new guide.

Changes

Cohort / File(s)	Summary
Documentation Addition en/docs/developer-guides/protocols-and-connectors/how-to-use-connetors.md	New how-to guide (~122 lines) explaining connections (auth, endpoints, transport), creating a new integration, pre-creating HTTP connections (example: https://jsonplaceholder.typicode.com), creating connections during design, sample API responses, and embedded GIFs/images.
Navigation Configuration en/mkdocs.yml	Added navigation entry under Developer Guides → Protocols and Connectors linking the new "Using Connectors" guide (corrected spelling in nav).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 I hop through docs with a twitchy nose,
I stitch connections where data flows.
GIFs and steps in tidy rows,
Integrations bloom where the connector goes,
A joyful nibble — off I go! 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Add new guides for using connectors' accurately summarizes the main change—adding documentation on connector usage for WSO2 Integrator: BI.
Description check	✅ Passed	The PR description covers Purpose, Goals, Approach, Release note, Documentation, Samples, and Test environment sections matching the template requirements with substantial detail.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 3

🤖 Fix all issues with AI agents

In `@en/docs/developer-guides/protocols-and-connectors/how-to-use-connetors.md`:
- Line 1: The document title contains a user-facing typo "How To Use Connetors";
update the title string to "How To Use Connectors" (replace the header line that
currently reads "# How To Use Connetors" with "# How To Use Connectors") so the
displayed heading and searchability are corrected.
- Around line 31-33: The heading "## Create a connection before building an
integration" is misleading because the steps assume you're in an integration's
Design view; rename the heading to "Create a connection before building the
automation flow" (or similar) and update the intro sentence to clarify the
workflow by adding a note like "If you've already created the integration, open
its Design view to add connections; otherwise create the integration first" so
readers know whether to create the integration or proceed directly to the Design
view.

In `@en/mkdocs.yml`:
- Line 127: Update the misspelled nav entry "- Using Connectors:
developer-guides/protocols-and-connectors/how-to-use-connetors.md" in
en/mkdocs.yml to match the corrected document filename/title by changing
"how-to-use-connetors.md" to "how-to-use-connectors.md" so the navigation link
points to the valid file.

🧹 Nitpick comments (1)

en/docs/developer-guides/protocols-and-connectors/how-to-use-connetors.md (1)

55-63: Consider anonymizing the sample module path in terminal output.

Using a personal module path (sachindu/connectors) in docs can look like a leaked local detail; a neutral placeholder reads better.

📝 Suggested fix

-        time=2026-01-22T13:07:54.519+05:30 level=INFO module=sachindu/connectors message="{
+        time=2026-01-22T13:07:54.519+05:30 level=INFO module=example/connectors message="{

Also applies to: 100-108

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@en/docs/developer-guides/protocols-and-connectors/how-to-use-connectors.md`:
- Line 49: Replace the awkward bold+asterisk labels like "**URL***" and
"**Path***" with consistent formatting by moving the required-field asterisk
outside the bold (e.g., "**URL** *" or "**URL** (required)") or by using plain
bold for the field name and a separate indicator for required fields; update the
occurrences of "URL" and "Path" in the document (including the instances shown
in the diff) so they render as "**URL**" and "**Path**" with the
asterisk/required marker kept separate.
- Line 1: The document heading contains a typo "How To Use Connetors" — update
the top-level heading text to "How To Use Connectors" so the user-facing title
is spelled correctly; locate and replace the heading string in the file (the
line starting with "# How To Use Connetors") to the corrected form.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Clean up bold/asterisk field labels.

**URL*** / **Path*** render awkwardly; use a consistent label (e.g., **URL** and **Path**) and keep required-field asterisks separate if needed.

✅ Proposed fix

-3. In the **URL*** field, enter the base service URL (for example, `https://jsonplaceholder.typicode.com`).
+3. In the **URL** field, enter the base service URL (for example, `https://jsonplaceholder.typicode.com`).

-8. In the **Path*** field, enter the resource path (for example, `/posts/1`).
+8. In the **Path** field, enter the resource path (for example, `/posts/1`).

Also applies to: 97-97

🤖 Prompt for AI Agents

In `@en/docs/developer-guides/protocols-and-connectors/how-to-use-connectors.md`
at line 49, Replace the awkward bold+asterisk labels like "**URL***" and
"**Path***" with consistent formatting by moving the required-field asterisk
outside the bold (e.g., "**URL** *" or "**URL** (required)") or by using plain
bold for the field name and a separate indicator for required fields; update the
occurrences of "URL" and "Path" in the document (including the instances shown
in the diff) so they render as "**URL**" and "**Path**" with the
asterisk/required marker kept separate.

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@en/docs/developer-guides/protocols-and-connectors/how-to-use-connetors.md`:
- Line 1: Delete the duplicate typo file named how-to-use-connetors.md (the
orphaned file with the misspelling) from the repository; ensure you do not
change the existing correct file how-to-use-connectors.md or its references in
mkdocs.yml, remove the typo file from version control (git rm and commit) so
only the correctly named document remains and no broken/duplicate documentation
entry exists.

🧹 Nitpick comments (1)

en/docs/developer-guides/protocols-and-connectors/how-to-use-connetors.md (1)

38-43: Optional: vary sentence starts in the “Use this approach when…” bullets.

Multiple bullets start with “You …”; consider mixing phrasing for readability.

Also applies to: 81-86