Add Documentation to Include Workspace Feature #197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

lnash94 wants to merge 11 commits into wso2:main from lnash94:main

en/docs/assets/img/developer-guides/workspace/add-integration-to-workspace.png

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

en/docs/assets/img/developer-guides/workspace/add-integration.gif

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

en/docs/assets/img/developer-guides/workspace/convert-integration-to-workspace.gif

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

en/docs/assets/img/developer-guides/workspace/create-integration-hq.gif

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

en/docs/assets/img/developer-guides/workspace/create-integration.png

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

en/docs/assets/img/developer-guides/workspace/delete-integration.gif

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

en/docs/assets/img/developer-guides/workspace/expand_workspace.png

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

en/docs/assets/img/developer-guides/workspace/navigate-integration.gif

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

en/docs/assets/img/developer-guides/workspace/open-workspace.gif

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

en/docs/assets/img/developer-guides/workspace/standalone-project-add.png

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

en/docs/assets/img/developer-guides/workspace/workspace_details.png

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

en/docs/developer-guides/create-a-project.md

This file was deleted.

en/docs/developer-guides/overview.md

-Original file line number
+Diff line change
@@ -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/)

en/docs/developer-guides/workspace-management/create-an-integration.md

-Original file line number
+Diff line change
@@ -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.
+\. Launch WSO2 Integrator: BI and navigate to the integrations view.
+\. Click the **Create New Integration** button.
+\. 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.
+    <a href="{{base_path}}/assets/img/developer-guides/workspace/create-integration-hq.gif"><img src="../../../assets/img/developer-guides/workspace/create-integration-hq.gif" alt="Create Integration Without Workspace" width="80%"></a>
+    ## Create an integration with workspace
+    Creating an integration within a workspace provides better organization and enables advanced features for managing multiple related integrations.
+\. Launch WSO2 Integrator: BI and navigate to the integrations view
+\. Click on the **Create New Integration** button, add details:
+    - Provide the integration name
+    - Provide a package name
+    - Select the path
+\. Expand **Optional Configurations** and enable  **Create as workspace** option
+    - Provide relevant workspace name
+    - Provide the organization name and version (Optional):
+      <a href="{{base_path}}/assets/img/developer-guides/workspace/expand_workspace.png"><img src="../../../assets/img/developer-guides/workspace/expand_workspace.png" alt="Expand Workspace Details Form" width="80%"></a>
+      <a href="{{base_path}}/assets/img/developer-guides/workspace/workspace_details.png"><img src="../../../assets/img/developer-guides/workspace/workspace_details.png" alt="Expand Workspace Details Form" width="80%"></a>
+\. 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/).

en/docs/developer-guides/workspace-management/manage-integrations-in-workspaces.md

-Original file line number
+Diff line change
@@ -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.
+\. Open your workspace
+       <a href="{{base_path}}/assets/img/developer-guides/workspace/open-workspace.gif"><img src="../../../assets/img/developer-guides/workspace/open-workspace.gif" alt="Select Workspace" width="80%"></a>
+\. 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.
+       <a href="{{base_path}}/assets/img/developer-guides/workspace/add-integration-to-workspace.png"><img src="../../../assets/img/developer-guides/workspace/add-integration-to-workspace.png" alt="Add Integration to Workspace" width="80%"></a>
+\. Add details:
+    - Provide the integration name
+    - Provide a package name
+    <a href="{{base_path}}/assets/img/developer-guides/workspace/create-integration.png"><img src="../../../assets/img/developer-guides/workspace/create-integration.png" alt="Create Integration" width="80%"></a>
+\. Click **Add Integration** to add it to your workspace, The new integration is added to your workspace and appears in the workspace navigator.
+    <a href="{{base_path}}/assets/img/developer-guides/workspace/add-integration.gif"><img src="../../../assets/img/developer-guides/workspace/add-integration.gif" alt="Add Integration" width="80%"></a>
+    ## 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.
+\. Open the standalone integration
+\. Click the **+** button next to the title WSO2 Integrator: BI at the top of the activity bar (left-side panel)
+    <a href="{{base_path}}/assets/img/developer-guides/workspace/standalone-project-add.png"><img src="../../../assets/img/developer-guides/workspace/standalone-project-add.png" alt="Convert Integration to Workspace" width="30%"></a>
+\. Add details to Convert to Workspace & Add Integration form:
+    - Provide the workspace name
+    - Provide the integration name
+    - Provide a package name
+    <a href="{{base_path}}/assets/img/developer-guides/workspace/convert-integration-to-workspace.gif"><img src="../../../assets/img/developer-guides/workspace/convert-integration-to-workspace.gif" alt="Add Integration to Workspace" width="80%"></a>
+    ## Delete an integration
+    Hover over an integration you want to delete on the workspace overview page, Click the **Delete** button.
+    <a href="{{base_path}}/assets/img/developer-guides/workspace/delete-integration.gif"><img src="../../../assets/img/developer-guides/workspace/delete-integration.gif" alt="Delete Integration from Workspace" width="80%"></a>
+    ## 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.
+    <a href="{{base_path}}/assets/img/developer-guides/workspace/navigate-integration.gif"><img src="../../../assets/img/developer-guides/workspace/navigate-integration.gif" alt="Navigate Integration" width="80%"></a>

en/docs/index.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -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/"},
@@ Expand Down @@

en/docs/integration-guides/usecases/datamapper/overview.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -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)

en/mkdocs.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -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
@@ Expand Down @@