Add documentation detailing Private Data Plane management models.#168
Add documentation detailing Private Data Plane management models.#168Sachindu-Nethmin wants to merge 1 commit intowso2:mainfrom
Conversation
WalkthroughIntroduces comprehensive documentation for three Private Data Plane management models, detailing responsibilities and workflows across infrastructure, deployment, monitoring, and security tasks. Navigation structure updated to reference the new documentation file. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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: 3
🧹 Nitpick comments (1)
en/docs/references/private-data-plane-management-models.md (1)
137-167: Consider adding brief task descriptions for application lifecycle rows.The "Task description" cells for all four application rows (
Devant application creation/deployment,Devant application management,Devant application monitoring,Devant application logs) are empty in all three tables. A one-line description for each would make the table self-contained and consistent with the other rows.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/docs/references/private-data-plane-management-models.md` around lines 137 - 167, Add a one-line "Task description" for each of the four table rows labeled "Devant application creation/deployment", "Devant application management", "Devant application monitoring", and "Devant application logs" so the tables are self-contained and consistent; for each row update the empty Task description cell to a concise phrase (e.g., creation/deployment = "Provision and deploy Devant applications and services", management = "Configure settings, scaling and access controls", monitoring = "Collect metrics and health checks for Devant services", logs = "Aggregate and store application logs for troubleshooting") and apply these descriptions to the corresponding cells in all three tables where those row labels appear.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/docs/references/private-data-plane-management-models.md`:
- Around line 23-25: The file contains invalid HTML using the closing tag
"</br>" in multiple table cells (e.g., the table rows shown around lines 23–25
and the other listed ranges); replace every occurrence of "</br>" with the
correct void tag "<br>" across all three tables (all instances in the document,
including the ones noted at 41–42, 58–59, 67–68, 84–85, 109–110, 118–130) so
that all line-breaks use a valid <br> element and the markup is well-formed.
- Line 63: Update the table cell text entries that currently read "Customer(If
required)" and "WSO2(If required)" to include a space before the qualifier so
they read "Customer (If required)" and "WSO2 (If required)"; locate and fix each
occurrence by searching for the exact strings "Customer(If required)" and
"WSO2(If required)" in the document and replace them with the spaced variants to
match the existing "Customer (If required)" formatting.
In `@en/mkdocs.yml`:
- Around line 146-149: The navigation entry "Private Data Plane Management
Models" in mkdocs.yml is currently a sibling of "Autoscale" due to 6-space
indentation; decide whether to nest it under the "Autoscale" section or correct
the PR text: if you want it nested under Autoscale, change the indentation of
the "Private Data Plane Management Models" line to match the nested items under
"Autoscale" (use the same 8-space indentation as "Autoscale Component Replicas"
and "Autoscale Components with Scale-to-Zero"); otherwise, leave the indentation
as-is and update the PR description to state that the page is added as a sibling
of "Autoscale" under References.
---
Nitpick comments:
In `@en/docs/references/private-data-plane-management-models.md`:
- Around line 137-167: Add a one-line "Task description" for each of the four
table rows labeled "Devant application creation/deployment", "Devant application
management", "Devant application monitoring", and "Devant application logs" so
the tables are self-contained and consistent; for each row update the empty Task
description cell to a concise phrase (e.g., creation/deployment = "Provision and
deploy Devant applications and services", management = "Configure settings,
scaling and access controls", monitoring = "Collect metrics and health checks
for Devant services", logs = "Aggregate and store application logs for
troubleshooting") and apply these descriptions to the corresponding cells in all
three tables where those row labels appear.
| <td>- Create subscriptions</br> | ||
| - Check quota and service limits</br> | ||
| - Run the Devant compatibility prerequisite script</td> |
There was a problem hiding this comment.
Replace invalid </br> end-tags with <br> throughout all three tables.
</br> is not valid HTML — it would imply that <br> accepts content, which it does not as a void element. The correct form is <br> (or <br/> for XHTML compatibility). This invalid tag pattern is pervasive across all three tables (lines 23–25, 41–42, 58–59, 67–68, 84–85, 109–110, 118–130, and their equivalents in Tables 2 and 3).
🐛 Proposed fix (representative hunk from Table 1)
-<td>- Create subscriptions</br>
- - Check quota and service limits</br>
- - Run the Devant compatibility prerequisite script</td>
+<td>- Create subscriptions<br>
+ - Check quota and service limits<br>
+ - Run the Devant compatibility prerequisite script</td>Apply the same substitution (</br> → <br>) at every occurrence in the file.
Also applies to: 41-42, 58-59, 67-68, 84-85, 109-110, 118-130
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/docs/references/private-data-plane-management-models.md` around lines 23 -
25, The file contains invalid HTML using the closing tag "</br>" in multiple
table cells (e.g., the table rows shown around lines 23–25 and the other listed
ranges); replace every occurrence of "</br>" with the correct void tag "<br>"
across all three tables (all instances in the document, including the ones noted
at 41–42, 58–59, 67–68, 84–85, 109–110, 118–130) so that all line-breaks use a
valid <br> element and the markup is well-formed.
| <td>WSO2</td> | ||
| <td>WSO2</td> | ||
| <td>-</td> | ||
| <td>Customer(If required)</td> |
There was a problem hiding this comment.
Add missing space before (If required) qualifiers.
Multiple cells have Customer(If required) / WSO2(If required) without a space, inconsistent with the correctly spaced Customer (If required) on lines 28–29.
Affected lines: 63, 80, 105, 244, 269, 391, 400.
✏️ Proposed fix (all occurrences)
-<td>Customer(If required)</td>
+<td>Customer (If required)</td>-<td>WSO2(If required)</td>
+<td>WSO2 (If required)</td>Also applies to: 80-80, 105-105, 244-244, 269-269, 391-391, 400-400
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/docs/references/private-data-plane-management-models.md` at line 63,
Update the table cell text entries that currently read "Customer(If required)"
and "WSO2(If required)" to include a space before the qualifier so they read
"Customer (If required)" and "WSO2 (If required)"; locate and fix each
occurrence by searching for the exact strings "Customer(If required)" and
"WSO2(If required)" in the document and replace them with the spaced variants to
match the existing "Customer (If required)" formatting.
| - Autoscale: | ||
| - Autoscale Component Replicas: devops-and-ci-cd/autoscale/autoscale-component-replicas.md | ||
| - Autoscale Components with Scale-to-Zero: devops-and-ci-cd/autoscale/autoscale-components-with-scale-to-zero.md | ||
| - Private Data Plane Management Models: references/private-data-plane-management-models.md |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
fd -t f mkdocs.yml | head -20Repository: wso2/docs-devant
Length of output: 73
🏁 Script executed:
# First, find the file and read the relevant section
find . -name "mkdocs.yml" -path "*/en/*" -type fRepository: wso2/docs-devant
Length of output: 75
🏁 Script executed:
# Look for the file and read lines around 146-149
find . -path "*/en/mkdocs.yml" -type f -exec cat -n {} \; | sed -n '140,155p'Repository: wso2/docs-devant
Length of output: 1185
Clarify navigation intent — entry is currently a sibling of Autoscale, not nested under it.
The entry at line 149 uses 6-space indentation, placing it as a peer of Autoscale under References. Entries nested inside Autoscale use 8 spaces (lines 147–148). The PR description states the page was registered "under the Autoscale section," which would require 8-space indentation and does not match the current placement.
Choose one:
- Nest it under Autoscale (change line 149 to 8-space indentation)
- Update the PR description if the current placement (as a sibling of
Autoscale) is intentional—a reasonable choice given the page covers infrastructure provisioning, Kubernetes, security, and more.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/mkdocs.yml` around lines 146 - 149, The navigation entry "Private Data
Plane Management Models" in mkdocs.yml is currently a sibling of "Autoscale" due
to 6-space indentation; decide whether to nest it under the "Autoscale" section
or correct the PR text: if you want it nested under Autoscale, change the
indentation of the "Private Data Plane Management Models" line to match the
nested items under "Autoscale" (use the same 8-space indentation as "Autoscale
Component Replicas" and "Autoscale Components with Scale-to-Zero"); otherwise,
leave the indentation as-is and update the PR description to state that the page
is added as a sibling of "Autoscale" under References.
1 participant
Purpose
Add documentation for Private Data Plane (PDP) management models to the Devant documentation site.
Goals
Provide users with clear reference documentation outlining the three PDP management models — WSO2 fully managed (WSO2 subscription), WSO2 fully managed (customer subscription), and customer self-managed — along with their RACI responsibility breakdowns.
Approach
en/docs/references/private-data-plane-management-models.mdwith three HTML tables detailing task ownership across WSO2 and customer parties for each management model.en/mkdocs.yml.Release note
Added reference documentation for Private Data Plane management models, covering WSO2 fully managed and customer self-managed scenarios with detailed responsibility matrices.
Documentation
en/docs/references/private-data-plane-management-models.mdSecurity checks
Screencast.from.2026-02-23.08-37-09.webm