Add Documentation to Include Workspace Feature #197
Conversation
lnash94
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughThis pull request restructures developer documentation by replacing the "Create a Project" guide with a new "Create Integrations" section. The changes include updating navigation configuration, adding three new documentation files covering integration overview and workspace management, removing the old project creation guide, and updating a cross-reference link. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
en/docs/developer-guides/workspace-management/create-integration.md (1)
1-44: Clear workflow documentation with good visual support.The two creation paths (with and without workspace) are well-documented with step-by-step instructions and field explanations. Optional configurations are properly marked.
Minor note: Line 18 mentions "Now you will see the BI home page" but includes no visual reference. Consider adding an image or removing this introductory line for clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (12)
en/docs/assets/img/developer-guides/workspace/add-integration-to-workspace.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/add-integration.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/add_integration_to_workspace.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/convert-integration-to-workspace.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/create-integration-hq.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/create-integration.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/delete-integration.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/expand_workspace.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/navigate-integration.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/open-workspace.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/standalone-project-add.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/workspace_details.pngis excluded by!**/*.png
📒 Files selected for processing (5)
en/docs/developer-guides/workspace-management/create-integration.md(1 hunks)en/docs/developer-guides/workspace-management/manage-workspace.md(1 hunks)en/docs/developer-guides/workspace-management/overview.md(1 hunks)en/docs/index.md(1 hunks)en/mkdocs.yml(1 hunks)
🔇 Additional comments (4)
en/docs/index.md (1)
23-24: URL paths align with navigation structure.The two new Developer Guides links follow the established pattern (no .md extension) and are well-positioned within the tile. Confirmed alignment with mkdocs.yml navigation entries.
en/docs/developer-guides/workspace-management/overview.md (1)
1-37: Well-structured overview with clear use-case guidance.The page effectively introduces workspaces with proper context (availability, definition, use cases, and benefits). The distinction between single integrations and complex projects is particularly helpful for users deciding whether to adopt workspaces.
en/docs/developer-guides/workspace-management/manage-workspace.md (1)
1-58: Comprehensive management workflow documentation with good visual coverage.The page effectively documents all key workspace management operations (add, convert, delete, navigate) with clear step-by-step instructions and visual aids for each workflow.
en/mkdocs.yml (1)
121-124: Navigation structure correctly reflects new documentation suite.The Workspace Management subsection is properly integrated with correct indentation, file path references, and logical positioning within the Developer Guides hierarchy. All three pages are correctly referenced.
en/docs/developer-guides/workspace-management/manage-workspace.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the workspace management feature introduced in WSO2 Integrator: BI 1.5.0. The documentation helps users understand when to use workspaces, how to create integrations with or without workspaces, and how to manage integrations within workspaces.
- Adds three new documentation pages covering workspace concepts, integration creation workflows, and workspace management operations
- Updates navigation structure to include the new workspace management section
- Includes supporting screenshots and GIFs to illustrate the workflows
Reviewed changes
Copilot reviewed 5 out of 17 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| en/mkdocs.yml | Adds workspace management section to documentation navigation with three sub-pages |
| en/docs/index.md | Updates landing page navigation to include workspace management and create integration links |
| en/docs/developer-guides/workspace-management/overview.md | Introduces workspace concepts, benefits, and use cases for single vs. complex projects |
| en/docs/developer-guides/workspace-management/create-integration.md | Documents step-by-step processes for creating integrations with and without workspaces |
| en/docs/developer-guides/workspace-management/manage-workspace.md | Explains how to add, convert, delete, and navigate integrations within workspaces |
| en/docs/assets/img/developer-guides/workspace/standalone-project-add.png | Adds screenshot image to support documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
en/docs/developer-guides/workspace-management/manage-workspace.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/manage-workspace.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/manage-workspace.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/create-integration.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/create-integration.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/manage-workspace.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (12)
en/docs/assets/img/developer-guides/workspace/add-integration-to-workspace.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/add-integration.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/add_integration_to_workspace.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/convert-integration-to-workspace.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/create-integration-hq.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/create-integration.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/delete-integration.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/expand_workspace.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/navigate-integration.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/open-workspace.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/standalone-project-add.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/workspace_details.pngis excluded by!**/*.png
📒 Files selected for processing (5)
en/docs/developer-guides/workspace-management/create-integration.md(1 hunks)en/docs/developer-guides/workspace-management/manage-workspace.md(1 hunks)en/docs/developer-guides/workspace-management/overview.md(1 hunks)en/docs/index.md(1 hunks)en/mkdocs.yml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- en/docs/developer-guides/workspace-management/manage-workspace.md
🚧 Files skipped from review as they are similar to previous changes (3)
- en/docs/developer-guides/workspace-management/overview.md
- en/docs/developer-guides/workspace-management/create-integration.md
- en/docs/index.md
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (12)
en/docs/assets/img/developer-guides/workspace/add-integration-to-workspace.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/add-integration.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/add_integration_to_workspace.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/convert-integration-to-workspace.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/create-integration-hq.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/create-integration.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/delete-integration.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/expand_workspace.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/navigate-integration.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/open-workspace.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/workspace/standalone-project-add.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/workspace/workspace_details.pngis excluded by!**/*.png
📒 Files selected for processing (5)
en/docs/developer-guides/workspace-management/create-integration.md(1 hunks)en/docs/developer-guides/workspace-management/manage-workspace.md(1 hunks)en/docs/developer-guides/workspace-management/overview.md(1 hunks)en/docs/index.md(1 hunks)en/mkdocs.yml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- en/docs/developer-guides/workspace-management/manage-workspace.md
🚧 Files skipped from review as they are similar to previous changes (2)
- en/docs/developer-guides/workspace-management/overview.md
- en/docs/index.md
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-11-12T05:34:19.589Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/network-level-security.md:1-20
Timestamp: 2025-11-12T05:34:19.589Z
Learning: In the wso2/docs-bi repository documentation files, using h3 (###) subsection headings directly under h1 (#) titles is an intentional style choice, even though it violates standard markdown heading increment rules.
Applied to files:
en/docs/developer-guides/workspace-management/create-integration.md
📚 Learning: 2025-11-12T05:34:18.459Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/os-level-security.md:1-25
Timestamp: 2025-11-12T05:34:18.459Z
Learning: In the WSO2 docs-bi repository, specifically in deployment best practices documentation files under en/docs/deploy/deployment-best-practices/, using h3 (###) headings directly after h1 titles (instead of h2) is intentional and should not be flagged.
Applied to files:
en/docs/developer-guides/workspace-management/create-integration.md
🔇 Additional comments (1)
en/mkdocs.yml (1)
121-124: Navigation structure is sound.The new "Workspace Management" section is properly integrated into the Developer Guides navigation with correct YAML syntax, indentation, and path references. The placement aligns well with existing content organization.
en/docs/developer-guides/workspace-management/create-integration.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/create-integration.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/create-integration.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/manage-workspace.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/manage-workspace.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/manage-workspace.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/manage-workspace.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/manage-workspace.md
Outdated
Show resolved
Hide resolved
en/docs/developer-guides/workspace-management/manage-workspace.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI Agents
In @en/docs/developer-guides/workspace-management/create-an-integration.md:
- Around line 38-39: Update the alt attribute for the second image tag (the one
with src "../../../assets/img/developer-guides/workspace/workspace_details.png")
so it is distinct and descriptive—replace alt="Expand Workspace Details Form"
with a more accurate description such as alt="Workspace Details Form" (or
"Filled Workspace Configuration") to improve accessibility.
🧹 Nitpick comments (1)
en/docs/integration-guides/usecases/datamapper/overview.md (1)
45-45: Consider updating the link text to match the new target.The link text still says "Create a Project" but now points to
overview.md. If the overview page covers more than just project creation, consider updating the link text to something like "Developer Guide Overview" or "Getting Started" for clarity.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
en/docs/developer-guides/create-a-project.mden/docs/developer-guides/overview.mden/docs/developer-guides/workspace-management/create-an-integration.mden/docs/index.mden/docs/integration-guides/usecases/datamapper/overview.mden/mkdocs.yml
💤 Files with no reviewable changes (1)
- en/docs/developer-guides/create-a-project.md
✅ Files skipped from review due to trivial changes (1)
- en/docs/developer-guides/overview.md
🚧 Files skipped from review as they are similar to previous changes (1)
- en/docs/index.md
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-11-12T05:34:19.589Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/network-level-security.md:1-20
Timestamp: 2025-11-12T05:34:19.589Z
Learning: In the wso2/docs-bi repository documentation files, using h3 (###) subsection headings directly under h1 (#) titles is an intentional style choice, even though it violates standard markdown heading increment rules.
Applied to files:
en/docs/developer-guides/workspace-management/create-an-integration.md
📚 Learning: 2025-11-12T05:34:18.459Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/os-level-security.md:1-25
Timestamp: 2025-11-12T05:34:18.459Z
Learning: In the WSO2 docs-bi repository, specifically in deployment best practices documentation files under en/docs/deploy/deployment-best-practices/, using h3 (###) headings directly after h1 titles (instead of h2) is intentional and should not be flagged.
Applied to files:
en/docs/developer-guides/workspace-management/create-an-integration.md
🔇 Additional comments (1)
en/mkdocs.yml (1)
109-112: All referenced navigation files exist.All three files referenced in the "Create Integrations" navigation section are present:
developer-guides/overview.md✓developer-guides/workspace-management/create-an-integration.md✓developer-guides/workspace-management/manage-integrations-in-workspaces.md✓No broken navigation links.
|
Updated the PR with below changes
Screen.Recording.2026-01-06.at.13.53.55.mov |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI Agents
In @en/docs/developer-guides/workspace-management/create-an-integration.md:
- Around line 38-39: The second image tag currently repeats the alt text "Expand
Workspace Details Form"; update its alt attribute to a distinct, descriptive
string such as "Workspace Details Form (filled)" or "Workspace Details View" to
reflect the different UI state so screen readers can distinguish the two images
(edit the second <img ... alt="..."> element in the provided diff to change the
alt text).
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
en/docs/developer-guides/create-a-project.mden/docs/developer-guides/overview.mden/docs/developer-guides/workspace-management/create-an-integration.mden/docs/index.mden/docs/integration-guides/usecases/datamapper/overview.mden/mkdocs.yml
💤 Files with no reviewable changes (1)
- en/docs/developer-guides/create-a-project.md
🚧 Files skipped from review as they are similar to previous changes (2)
- en/docs/integration-guides/usecases/datamapper/overview.md
- en/mkdocs.yml
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-11-12T05:34:19.589Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/network-level-security.md:1-20
Timestamp: 2025-11-12T05:34:19.589Z
Learning: In the wso2/docs-bi repository documentation files, using h3 (###) subsection headings directly under h1 (#) titles is an intentional style choice, even though it violates standard markdown heading increment rules.
Applied to files:
en/docs/developer-guides/workspace-management/create-an-integration.md
📚 Learning: 2025-11-12T05:34:18.459Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/os-level-security.md:1-25
Timestamp: 2025-11-12T05:34:18.459Z
Learning: In the WSO2 docs-bi repository, specifically in deployment best practices documentation files under en/docs/deploy/deployment-best-practices/, using h3 (###) headings directly after h1 titles (instead of h2) is intentional and should not be flagged.
Applied to files:
en/docs/developer-guides/workspace-management/create-an-integration.md
🔇 Additional comments (4)
en/docs/index.md (1)
19-19: Navigation entry resolves the duplicate page concern.Adding "Create Integrations" as a top-level entry under Developer Guides addresses the prior review comment about navigation confusion. This provides a clear, explicit entry point to the workspace feature overview, making the information architecture more discoverable.
en/docs/developer-guides/workspace-management/create-an-integration.md (1)
3-44: Document structure and content flow are clear.The two-path approach (with/without workspace) is well-organized with distinct sections, step-by-step instructions, and appropriate visual references. The progression from standalone integrations to workspace-based organization is logical and helpful for users at different experience levels.
en/docs/developer-guides/overview.md (2)
1-27: Clear overview of workspace concepts and use cases.The document effectively explains when to use workspaces (single vs. complex integrations) and articulates key benefits. The version compatibility note and feature availability context are helpful. Heading structure follows the repository's established pattern (h3 after h1).
39-44: Links verified and properly configured.Both workspace management documentation files exist and are correctly referenced in the mkdocs.yml navigation structure for proper sidebar rendering:
create-an-integration.md✓manage-integrations-in-workspaces.md✓Navigation is properly configured with appropriate labels.
5 participants
Fix #wso2/product-ballerina-integrator#1978
Content reference: https://gist.github.com/dulajdilshan/020b445b3b5b39d08ff9869cb16f4eee
Screen.Recording.2025-12-08.at.15.07.57.mov
Summary by CodeRabbit
Release Notes
✏️ Tip: You can customize this high-level summary in your review settings.