diff --git a/en/docs/assets/img/developer-guides/workspace/add-integration-to-workspace.png b/en/docs/assets/img/developer-guides/workspace/add-integration-to-workspace.png new file mode 100644 index 00000000..c5a4df9d Binary files /dev/null and b/en/docs/assets/img/developer-guides/workspace/add-integration-to-workspace.png differ diff --git a/en/docs/assets/img/developer-guides/workspace/add-integration.gif b/en/docs/assets/img/developer-guides/workspace/add-integration.gif new file mode 100644 index 00000000..d9326744 Binary files /dev/null and b/en/docs/assets/img/developer-guides/workspace/add-integration.gif differ diff --git a/en/docs/assets/img/developer-guides/workspace/convert-integration-to-workspace.gif b/en/docs/assets/img/developer-guides/workspace/convert-integration-to-workspace.gif new file mode 100644 index 00000000..0989f84d Binary files /dev/null and b/en/docs/assets/img/developer-guides/workspace/convert-integration-to-workspace.gif differ diff --git a/en/docs/assets/img/developer-guides/workspace/create-integration-hq.gif b/en/docs/assets/img/developer-guides/workspace/create-integration-hq.gif new file mode 100644 index 00000000..9e068814 Binary files /dev/null and b/en/docs/assets/img/developer-guides/workspace/create-integration-hq.gif differ diff --git a/en/docs/assets/img/developer-guides/workspace/create-integration.png b/en/docs/assets/img/developer-guides/workspace/create-integration.png new file mode 100644 index 00000000..7da0971e Binary files /dev/null and b/en/docs/assets/img/developer-guides/workspace/create-integration.png differ diff --git a/en/docs/assets/img/developer-guides/workspace/delete-integration.gif b/en/docs/assets/img/developer-guides/workspace/delete-integration.gif new file mode 100644 index 00000000..3e7e0dd5 Binary files /dev/null and b/en/docs/assets/img/developer-guides/workspace/delete-integration.gif differ diff --git a/en/docs/assets/img/developer-guides/workspace/expand_workspace.png b/en/docs/assets/img/developer-guides/workspace/expand_workspace.png new file mode 100644 index 00000000..30a5b586 Binary files /dev/null and b/en/docs/assets/img/developer-guides/workspace/expand_workspace.png differ diff --git a/en/docs/assets/img/developer-guides/workspace/navigate-integration.gif b/en/docs/assets/img/developer-guides/workspace/navigate-integration.gif new file mode 100644 index 00000000..91f3e133 Binary files /dev/null and b/en/docs/assets/img/developer-guides/workspace/navigate-integration.gif differ diff --git a/en/docs/assets/img/developer-guides/workspace/open-workspace.gif b/en/docs/assets/img/developer-guides/workspace/open-workspace.gif new file mode 100644 index 00000000..8911da96 Binary files /dev/null and b/en/docs/assets/img/developer-guides/workspace/open-workspace.gif differ diff --git a/en/docs/assets/img/developer-guides/workspace/standalone-project-add.png b/en/docs/assets/img/developer-guides/workspace/standalone-project-add.png new file mode 100644 index 00000000..ed5c70cf Binary files /dev/null and b/en/docs/assets/img/developer-guides/workspace/standalone-project-add.png differ diff --git a/en/docs/assets/img/developer-guides/workspace/workspace_details.png b/en/docs/assets/img/developer-guides/workspace/workspace_details.png new file mode 100644 index 00000000..d9adff42 Binary files /dev/null and b/en/docs/assets/img/developer-guides/workspace/workspace_details.png differ diff --git a/en/docs/developer-guides/create-a-project.md b/en/docs/developer-guides/create-a-project.md deleted file mode 100644 index 66301cd4..00000000 --- a/en/docs/developer-guides/create-a-project.md +++ /dev/null @@ -1,46 +0,0 @@ -# Create a Project - -A project in WSO2 Integrator: BI is the foundational workspace where you define, organize, and manage all your integration artifacts—such as services, data mappings, and connections. - -Follow the steps below to create your first integration project using WSO2 Integrator: BI. - -## Steps to Create an Integration Project - -1. **Launch Visual Studio Code** with the WSO2 Integrator: BI extension enabled. - - !!! info - If you have not installed the extension, follow the [Install WSO2 Integrator: BI]({{base_path}}/get-started/install-wso2-integrator-bi/) guide. - -2. **Open the BI Extension** - - Click the BI icon on the **Activity Bar** of the VS Code editor. This opens the WSO2 Integrator: BI view. - - Screenshot showing the BI extension icon in the VS Code Activity Bar - -3. **Create a New Integration Project** - - Click on **Create New Integration** in the BI view. - - Screenshot of the 'Create New Integration' button in the BI extension view - -4. **Name and Choose Location for Your Project** - - Enter a suitable name for your integration project and select a location to save it. - - Screenshot of dialog to enter project name and select location - - _Expected outcome: A new integration project folder is created at your chosen location._ - -5. **Access the BI Home Page** - - Once the project is created, the BI home page will open automatically in VS Code. - - Screenshot of the BI home page in VS Code after project creation - - _Expected outcome: You should see the BI home page, ready for you to start developing integration artifacts._ - ---- - -Now, you can start creating your integration by developing artifacts. See the [WSO2 Integrator: BI Artifacts]({{base_path}}/developer-guides/wso2-integrator-bi-artifacts/) to learn about the integration artifacts. - -Additionally, you can enhance your experience by incorporating AI-powered assistance with [BI Copilot]({{base_path}}/developer-guides/ai-for-integration/build-an-http-service-with-wso2-copilot/). diff --git a/en/docs/developer-guides/overview.md b/en/docs/developer-guides/overview.md new file mode 100644 index 00000000..8ab6c4a5 --- /dev/null +++ b/en/docs/developer-guides/overview.md @@ -0,0 +1,44 @@ +# Overview + +Integration in WSO2 Integrator: BI is the foundational space for defining, organizing, and managing integration artifacts such as services, data mappings, and connections. +Integrations can contain either a single integration or multiple integrations grouped together as a workspace. + +## For single integrations + +When building a simple, standalone integration, you can work directly without a workspace. This approach is perfect for: + +- Quick, one-off integrations +- Independent services with no strong dependencies +- Simple proof-of-concepts + +## For complex integrations + +Workspaces become essential when you need to: + +- Organize related integrations – Group multiple integrations that belong to the same business domain or application +- Manage dependencies – Allow integrations to reference and use resources from other integrations within the workspace +- Simplify collaboration – Work on multi-integration projects with a clear organizational structure + +### What is a workspace? +A workspace is a collection of integration packages that can be organized and managed together in a single structure. This allows you to organize multiple related integrations in a single project structure. It provides a centralized environment where you can develop, manage, and maintain interdependent integrations. + +???+ Note + This feature is available from WSO2 Integrator: BI 1.5.0 onwards and Ballerina version 2201.13.0+. + +### Key benefits + +- Visual Organization – See all your related integrations in one place with an intuitive tree structure +- Seamless Navigation – Quickly switch between integrations without leaving your workspace +- Dependency Management – Integrations within a workspace can reference each other automatically +- Flexible Structure – Start with standalone integrations and convert them to workspaces as your project grows +- Reduced Context Switching - Consolidate related repositories (e.g., code + documentation + config) into one view. This minimizes mental load and window management, allowing developers to focus on the logical feature rather than the repository structure. +- Cross-Project Symbol Resolution - Enable "Go to Definition" and intelligent code navigation across distinct repositories. This removes the need to build or publish local packages to see changes in dependent projects, accelerating the feedback loop. +- Resource Optimization - Reduce the memory and CPU overhead of running multiple IDE instances. A single instance managing multiple roots lowers hardware requirements and improves performance on developer workstations. + + +Whether you're building a single integration or orchestrating a complex microservices architecture, WSO2 Integrator: BI provides the flexibility to work in the way that best suits your project's needs. + +Follow the below links to learn more about creating , managing workspaces and integrations: + +- [Creating an Integration](/developer-guides/workspace-management/create-an-integration) +- [Managing Integrations in Workspaces](/developer-guides/workspace-management/manage-integrations-in-workspaces/) diff --git a/en/docs/developer-guides/workspace-management/create-an-integration.md b/en/docs/developer-guides/workspace-management/create-an-integration.md new file mode 100644 index 00000000..bf286e58 --- /dev/null +++ b/en/docs/developer-guides/workspace-management/create-an-integration.md @@ -0,0 +1,45 @@ +# Create an Integration + +## Create an integration without workspace +When you need to build a simple, standalone integration, you can create it directly without setting up a workspace. This streamlined approach is ideal for independent services. + +1\. Launch WSO2 Integrator: BI and navigate to the integrations view. + +2\. Click the **Create New Integration** button. + +3\. Fill in **Create Your Integration** details and click **Create Integration**. + +- Provide the integration name +- Provide a package name +- Select the path +- Provide the organization name and version in **Optional Configurations** (Optional) + +Now you will see the BI home page. + +Create Integration Without Workspace + + +## Create an integration with workspace +Creating an integration within a workspace provides better organization and enables advanced features for managing multiple related integrations. + +1\. Launch WSO2 Integrator: BI and navigate to the integrations view + +2\. Click on the **Create New Integration** button, add details: + +- Provide the integration name +- Provide a package name +- Select the path + +3\. Expand **Optional Configurations** and enable **Create as workspace** option + +- Provide relevant workspace name +- Provide the organization name and version (Optional): + + Expand Workspace Details Form + Expand Workspace Details Form + +4\. Click **Create Integration** to initialize your integration + +Now, you can start creating your integration by developing artifacts. See the [WSO2 Integrator: BI Artifacts]({{base_path}}/developer-guides/wso2-integrator-bi-artifacts/) to learn about the integration artifacts. + +Additionally, you can enhance your experience by incorporating AI-powered assistance with [BI Copilot]({{base_path}}/developer-guides/ai-for-integration/build-an-http-service-with-wso2-copilot/). diff --git a/en/docs/developer-guides/workspace-management/manage-integrations-in-workspaces.md b/en/docs/developer-guides/workspace-management/manage-integrations-in-workspaces.md new file mode 100644 index 00000000..2f0a86fd --- /dev/null +++ b/en/docs/developer-guides/workspace-management/manage-integrations-in-workspaces.md @@ -0,0 +1,55 @@ +# Manage Integrations in Workspaces + +## Add an integration to an existing workspace + +Once you have a workspace, you can continue adding integrations to organize your project. + +1\. Open your workspace + + Select Workspace + +2\. Click the **+** button next to the title WSO2 Integrator: BI at the top of the activity bar (left-side panel) or the **+ Add Integration** button on the workspace title bar. + + Add Integration to Workspace + +3\. Add details: + +- Provide the integration name +- Provide a package name + +Create Integration + +4\. Click **Add Integration** to add it to your workspace, The new integration is added to your workspace and appears in the workspace navigator. + +Add Integration + + +## Add an integration by converting a standalone integration to a workspace + +If you started with a standalone integration and now need to add another integration by converting your integration to a workspace. + +1\. Open the standalone integration + +2\. Click the **+** button next to the title WSO2 Integrator: BI at the top of the activity bar (left-side panel) + +Convert Integration to Workspace + +3\. Add details to Convert to Workspace & Add Integration form: + +- Provide the workspace name +- Provide the integration name +- Provide a package name + +Add Integration to Workspace + +## Delete an integration + +Hover over an integration you want to delete on the workspace overview page, Click the **Delete** button. + +Delete Integration from Workspace + +## Navigate to an integration + +To access a specific integration to manage artifacts. Click the diagram icon (Show overview) of an integration in the activity panel or click a particular integration from the workspace overview page. + +Navigate Integration diff --git a/en/docs/index.md b/en/docs/index.md index 136e69cf..679f57ae 100644 --- a/en/docs/index.md +++ b/en/docs/index.md @@ -16,6 +16,7 @@ "title": "Developer Guides", "icon": "🛠️ ", "links": [ + {"name": "Create Integrations", "url": "developer-guides/overview"}, {"name": "Design the Integrations", "url": "developer-guides/design-the-integrations/"}, {"name": "Data Mapping", "url": "developer-guides/data-mapping/"}, {"name": "Testing", "url": "developer-guides/test-the-integrations/"}, diff --git a/en/docs/integration-guides/usecases/datamapper/overview.md b/en/docs/integration-guides/usecases/datamapper/overview.md index da2ce35d..ffecc54f 100644 --- a/en/docs/integration-guides/usecases/datamapper/overview.md +++ b/en/docs/integration-guides/usecases/datamapper/overview.md @@ -34,4 +34,4 @@ Use the Data Mapper when you need to: - [Data Mapping Quick Start](../../../developer-guides/data-mapping.md) - [Design the Integrations](../../../developer-guides/design-the-integrations.md) -- [Create a Project](../../../developer-guides/create-a-project.md) +- [Create a Project](../../../developer-guides/overview.md) diff --git a/en/mkdocs.yml b/en/mkdocs.yml index 5d349c41..ae9cd23d 100644 --- a/en/mkdocs.yml +++ b/en/mkdocs.yml @@ -108,7 +108,10 @@ nav: - Overview: integration-guides/usecases/datamapper/overview.md - Read a CSV File and Transform It to an XML File: integration-guides/usecases/datamapper/read-csv-file-and-transform-to-xml-file.md - Developer Guides: - - Create a Project: developer-guides/create-a-project.md + - Create Integrations: + Overview: developer-guides/overview.md + Create an Integration: developer-guides/workspace-management/create-an-integration.md + Manage Workspace: developer-guides/workspace-management/manage-integrations-in-workspaces.md - "WSO2 Integrator: BI Artifacts": developer-guides/wso2-integrator-bi-artifacts.md - Design the Integrations: developer-guides/design-the-integrations.md - Data Mapping: developer-guides/data-mapping.md