Skip to content

Commit 669e1ea

Browse files
committed
Move workspace doc to a common place with integration creation
1 parent 5aa4dba commit 669e1ea

File tree

6 files changed

+55
-54
lines changed

6 files changed

+55
-54
lines changed

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

Lines changed: 0 additions & 46 deletions
This file was deleted.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Overview
2+
3+
Integration in WSO2 Integrator: BI is the foundational space for defining, organizing, and managing integration artifacts such as services, data mappings, and connections.
4+
Integrations can contain either a single integration or multiple integrations grouped together as a workspace.
5+
6+
## For single integrations
7+
8+
When building a simple, standalone integration, you can work directly without a workspace. This approach is perfect for:
9+
10+
- Quick, one-off integrations
11+
- Independent services with no strong dependencies
12+
- Simple proof-of-concepts
13+
14+
## For complex integrations
15+
16+
Workspaces become essential when you need to:
17+
18+
- Organize related integrations – Group multiple integrations that belong to the same business domain or application
19+
- Manage dependencies – Allow integrations to reference and use resources from other integrations within the workspace
20+
- Simplify collaboration – Work on multi-integration projects with a clear organizational structure
21+
22+
### What is a workspace?
23+
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.
24+
25+
???+ Note
26+
This feature is available from WSO2 Integrator: BI 1.5.0 onwards and Ballerina version 2201.13.0+.
27+
28+
### Key benefits
29+
30+
- Visual Organization – See all your related integrations in one place with an intuitive tree structure
31+
- Seamless Navigation – Quickly switch between integrations without leaving your workspace
32+
- Dependency Management – Integrations within a workspace can reference each other automatically
33+
- Flexible Structure – Start with standalone integrations and convert them to workspaces as your project grows
34+
- 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.
35+
- 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.
36+
- 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.
37+
38+
39+
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.
40+
41+
Follow the below links to learn more about creating , managing workspaces and integrations:
42+
43+
- [Creating an Integration](/developer-guides/workspace-management/create-an-integration)
44+
- [Managing Integrations in Workspaces](/developer-guides/workspace-management/manage-integrations-in-workspaces/)

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,8 @@ Creating an integration within a workspace provides better organization and enab
3838
<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>
3939
<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>
4040

41-
4\. Click **Create Integration** to initialize your integration
41+
4\. Click **Create Integration** to initialize your integration
42+
43+
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.
44+
45+
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/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616
"title": "Developer Guides",
1717
"icon": "🛠️ ",
1818
"links": [
19+
{"name": "Create Integrations", "url": "developer-guides/overview"},
1920
{"name": "Design the Integrations", "url": "developer-guides/design-the-integrations/"},
2021
{"name": "Data Mapping", "url": "developer-guides/data-mapping/"},
2122
{"name": "Testing", "url": "developer-guides/test-the-integrations/"},
2223
{"name": "Debugging & Troubleshooting", "url": "developer-guides/debugging-and-troubleshooting/overview"},
23-
{"name": "Workspace Management", "url": "developer-guides/workspace-management/overview"},
2424
{"name": "Protocols and Connectors", "url": "developer-guides/protocols-and-connectors/overview-of-connectors/"},
2525
{"name": "Integration Tools", "url": "developer-guides/tools/integration-tools/health-tool/"},
2626
{"name": "Migration Tools", "url": "developer-guides/tools/migration-tools/mulesoft-migration-tool"},

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,6 @@ Use the Data Mapper when you need to:
4242

4343
- [Data Mapping Quick Start](../../../developer-guides/data-mapping.md)
4444
- [Design the Integrations](../../../developer-guides/design-the-integrations.md)
45-
- [Create a Project](../../../developer-guides/create-a-project.md)
45+
- [Create a Project](../../../developer-guides/overview.md)
4646

4747
---

en/mkdocs.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,10 @@ nav:
106106
- Overview: integration-guides/usecases/datamapper/overview.md
107107
- Read a CSV File and Transform It to an XML File: integration-guides/usecases/datamapper/read-csv-file-and-transform-to-xml-file.md
108108
- Developer Guides:
109-
- Create a Project: developer-guides/create-a-project.md
109+
- Create Integrations:
110+
Overview: developer-guides/overview.md
111+
Create an Integration: developer-guides/workspace-management/create-an-integration.md
112+
Manage Workspace: developer-guides/workspace-management/manage-integrations-in-workspaces.md
110113
- "WSO2 Integrator: BI Artifacts": developer-guides/wso2-integrator-bi-artifacts.md
111114
- Design the Integrations: developer-guides/design-the-integrations.md
112115
- Data Mapping: developer-guides/data-mapping.md
@@ -118,10 +121,6 @@ nav:
118121
Remote Debugging Integrations: developer-guides/debugging-and-troubleshooting/remote-debugging-integrations.md
119122
Capturing Strand Dumps: developer-guides/debugging-and-troubleshooting/capturing-strand-dumps.md
120123
Profiling Runtime Performance: developer-guides/debugging-and-troubleshooting/profiling-runtime-performance.md
121-
- Workspace Management:
122-
Overview: developer-guides/workspace-management/overview.md
123-
Create Integration: developer-guides/workspace-management/create-an-integration.md
124-
Manage Workspace: developer-guides/workspace-management/manage-integrations-in-workspaces.md
125124
- AI For Integration:
126125
- Build an HTTP Service With BI Copilot : developer-guides/ai-for-integration/build-an-http-service-with-wso2-copilot.md
127126
- Protocols and Connectors:

0 commit comments

Comments
 (0)