Add automation pipeline documentation #1839
Conversation
WalkthroughAdds an "Automation Pipelines" documentation subtree (five new pages) covering pipeline concepts, creation/management, running pipelines, and built-in templates; updates mkdocs navigation and applies minor whitespace formatting to the home page template. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant UI as Choreo UI
participant API as Pipeline Service
participant Runner as Execution Runner
participant Marketplace as Marketplace
Note over User,UI: Create or import pipeline
User->>UI: Create pipeline (inline YAML) / Import from Git
UI->>API: Save pipeline definition (metadata or repo ref)
User->>UI: Start run (provide variables/secrets/params)
UI->>API: Trigger pipeline run
API->>Runner: Schedule & execute steps (may reference templates `choreo/<name>@v1`)
Runner->>API: Stream logs & status
API->>UI: Stream logs/status to user
alt Run includes marketplace-publish step
API->>Marketplace: POST publish payload (choreo/marketplace-publish@v1)
Marketplace-->>API: Publish result
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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: 5
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/introduction.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md(1 hunks)en/pe-docs/mkdocs.yml(1 hunks)en/theme/material/templates/pe-home-page.html(15 hunks)
🧰 Additional context used
🪛 LanguageTool
en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md
[grammar] ~27-~27: Ensure spelling is correct
Context: ... Specific Pipeline Yaml File within and directory in the repository. 3. Provide...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~37-~37: Use a hyphen to join words.
Context: ...can view the pipeline definition in full screen view as well by maximizing the pa...
(QB_NEW_EN_HYPHEN)
en/pe-docs/docs/devops/automation-pipelines/introduction.md
[style] ~2-~2: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 530 characters long)
Context: # What are Automation Pipelines !!! info "Note" Automation pipeline cap...
(EN_EXCESSIVE_EXCLAMATION)
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
[style] ~50-~50: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3413 characters long)
Context: ...n the upper-right corner of the panel. !!! info "Note" Choreo keeps pipeline l...
(EN_EXCESSIVE_EXCLAMATION)
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
[style] ~12-~12: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1909 characters long)
Context: ...> ``` ## Available Built-in Templates !!! info "Note" The list of built-in te...
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
5-5: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
14-14: Link text should be descriptive
(MD059, descriptive-link-text)
50-50: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (6)
en/theme/material/templates/pe-home-page.html (1)
371-371: Verify the Automation Pipelines link path matches the mkdocs.yml entry.Line 371 links to
devops/automation-pipelines/introduction/, which should align with the mkdocs.yml navigation entry. Per the mkdocs.yml file, this entry is defined asdevops/automation-pipelines/introduction.md(which renders as/introduction/in the nav path). This looks correct, but ensure the file exists at the expected location before release.en/pe-docs/mkdocs.yml (1)
108-113: Navigation structure looks good.The new Automation Pipelines group is properly positioned within DevOps and correctly references all five documentation files. YAML syntax and indentation are correct.
en/pe-docs/docs/devops/automation-pipelines/introduction.md (1)
1-6: Clear and concise introduction.The introduction effectively explains Automation Pipelines, includes the important limitation note, and provides helpful external references to the pipeline specification and Argo workflows. The note about private data plane availability is appropriately positioned and visible.
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md (1)
1-56: Comprehensive and well-organized documentation.The guide clearly covers all essential tasks for running automation pipelines: configuring variables/secrets, setting parameters, executing runs, viewing logs, and managing run lifecycle. The important security note about secret vault injection and log retention policy are appropriately highlighted. The parameter YAML example is helpful and clear.
en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md (1)
1-47: Comprehensive pipeline management documentation.The file clearly documents all core pipeline management operations: creation (inline and Git import), editing, and deletion. Step-by-step instructions are easy to follow, and important constraints (no rollback after edit, Git-based pipelines use latest version) are prominently noted.
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md (1)
1-44: Well-structured template documentation.The built-in templates list is comprehensive with clear, concise descriptions for each template. The usage syntax is clearly explained, and the reference to the full external list accommodates future template additions without requiring doc updates.
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
Outdated
Show resolved
Hide resolved
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
Outdated
Show resolved
Hide resolved
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
Outdated
Show resolved
Hide resolved
en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md
Outdated
Show resolved
Hide resolved
en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md
Outdated
Show resolved
Hide resolved
abeykoon
force-pushed
the
add-automation-pipeline-docs
branch
from
56f1512 to
350a117
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/introduction.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md
🧰 Additional context used
🪛 LanguageTool
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
[style] ~50-~50: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3409 characters long)
Context: ...n the upper-right corner of the panel. !!! info "Note" Choreo keeps pipeline l...
(EN_EXCESSIVE_EXCLAMATION)
[grammar] ~55-~55: Ensure spelling is correct
Context: ...m for 30 days. ## Stop a Pipeline Run One a pipeline run is triggered, Click on *...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
[style] ~12-~12: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1916 characters long)
Context: ...> ``` ## Available Built-in Templates !!! info "Note" The list of built-in te...
(EN_EXCESSIVE_EXCLAMATION)
en/pe-docs/docs/devops/automation-pipelines/introduction.md
[style] ~2-~2: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 530 characters long)
Context: # What are Automation Pipelines !!! info "Note" Automation pipeline cap...
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
24-24: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (2)
en/pe-docs/docs/devops/automation-pipelines/introduction.md (1)
1-6: Content is clear and well-structured. The introduction effectively explains what automation pipelines are with appropriate links to external specifications and framework references. No changes needed.en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md (1)
1-80: All previous review comments have been addressed. The code blocks now include proper language identifiers (```yaml), the link text is descriptive, and the documentation is comprehensive and well-structured. Content covers templates clearly with good examples.
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
Outdated
Show resolved
Hide resolved
abeykoon
force-pushed
the
add-automation-pipeline-docs
branch
2 times, most recently
from
9d14457 to
595d681
Compare
abeykoon
force-pushed
the
add-automation-pipeline-docs
branch
from
595d681 to
5b9b2e4
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md (1)
54-56: Fix grammar and capitalization on line 56.Two errors on this line: the typo "One" should be "Once," and "Click" should be lowercased to "click" for consistent sentence structure.
Apply this diff:
- One a pipeline run is triggered, Click on **View Logs** and then in the log panel that opens to the right, click on **Stop Run**. + Once a pipeline run is triggered, click on **View Logs** and then in the log panel that opens to the right, click on **Stop Run**.en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md (1)
27-27: Capitalize the YAML acronym on line 27.The acronym should be "Pipeline YAML" (all caps) not "Pipeline Yaml" for consistency with standard technical conventions.
Apply this diff:
- 2. You can select **Repository**, **Branch** and Specific **Pipeline Yaml** file within a directory in the repository. + 2. You can select **Repository**, **Branch**, and specific **Pipeline YAML** file within a directory in the repository.(Minor additional suggestion: add Oxford comma after "Branch" for grammatical consistency.)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/introduction.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md(1 hunks)en/pe-docs/mkdocs.yml(1 hunks)en/theme/material/templates/pe-home-page.html(15 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- en/pe-docs/mkdocs.yml
- en/theme/material/templates/pe-home-page.html
🧰 Additional context used
🪛 LanguageTool
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
[style] ~12-~12: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1916 characters long)
Context: ...> ``` ## Available Built-in Templates !!! info "Note" The list of built-in te...
(EN_EXCESSIVE_EXCLAMATION)
en/pe-docs/docs/devops/automation-pipelines/introduction.md
[style] ~2-~2: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 530 characters long)
Context: # What are Automation Pipelines !!! info "Note" Automation pipeline cap...
(EN_EXCESSIVE_EXCLAMATION)
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
[style] ~50-~50: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3409 characters long)
Context: ...n the upper-right corner of the panel. !!! info "Note" Choreo keeps pipeline l...
(EN_EXCESSIVE_EXCLAMATION)
[grammar] ~55-~55: Ensure spelling is correct
Context: ...m for 30 days. ## Stop a Pipeline Run One a pipeline run is triggered, Click on *...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
24-24: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (2)
en/pe-docs/docs/devops/automation-pipelines/introduction.md (1)
1-6: LGTM!The introduction clearly establishes the scope and links to supporting resources. The note about private data plane organizations is important context for users.
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md (1)
1-80: LGTM!All prior review feedback has been incorporated. The templates documentation is complete with proper syntax highlighting, descriptive link text, and clear examples including the marketplace publishing use case.
abeykoon
force-pushed
the
add-automation-pipeline-docs
branch
from
5b9b2e4 to
0d06464
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (3)
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md (2)
24-30: Add language identifier to fenced code block.This YAML code block is missing the language identifier for proper syntax highlighting. This issue was identified in a previous review but remains unfixed.
Apply this diff:
-``` +```yaml parameters: - name: environment default: "Development" enum: ["Development", "Production"] displayName: "Environment" -``` +```
54-56: Fix grammar and capitalization errors.Two issues on line 56: (1) "One a pipeline run" is a grammatical error—should be "Once a pipeline run"; (2) "Click" should be lowercase "click" for consistency with sentence structure and the lowercase "click" used later in the same sentence. This issue was identified in a previous review but remains unfixed.
Apply this diff:
## Stop a Pipeline Run -One a pipeline run is triggered, Click on **View Logs** and then in the log panel that opens to the right, click on **Stop Run**. +Once a pipeline run is triggered, click on **View Logs** and then in the log panel that opens to the right, click on **Stop Run**.en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md (1)
27-27: Fix capitalization of YAML acronym.The acronym "YAML" should be in all caps per standard convention. Additionally, "Specific" should be lowercase "specific" for grammatical consistency in the list. This issue was flagged in a previous review and should have been addressed but still requires fixing.
Apply this diff:
-2. You can select **Repository**, **Branch** and Specific **Pipeline Yaml** file within a directory in the repository. +2. You can select **Repository**, **Branch**, and specific **Pipeline YAML** file within a directory in the repository.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/introduction.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
[style] ~12-~12: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1916 characters long)
Context: ...> ``` ## Available Built-in Templates !!! info "Note" The list of built-in te...
(EN_EXCESSIVE_EXCLAMATION)
en/pe-docs/docs/devops/automation-pipelines/introduction.md
[style] ~2-~2: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 530 characters long)
Context: # What are Automation Pipelines !!! info "Note" Automation pipeline cap...
(EN_EXCESSIVE_EXCLAMATION)
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
[style] ~50-~50: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3409 characters long)
Context: ...n the upper-right corner of the panel. !!! info "Note" Choreo keeps pipeline l...
(EN_EXCESSIVE_EXCLAMATION)
[grammar] ~55-~55: Ensure spelling is correct
Context: ...m for 30 days. ## Stop a Pipeline Run One a pipeline run is triggered, Click on *...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
24-24: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (1)
en/pe-docs/docs/devops/automation-pipelines/introduction.md (1)
1-6: Looks good!The introduction is well-structured with clear explanation of automation pipelines and proper scoping for private data plane organizations. Links are relevant and well-integrated.
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
Outdated
Show resolved
Hide resolved
abeykoon
force-pushed
the
add-automation-pipeline-docs
branch
2 times, most recently
from
981b336 to
2a8a386
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md (1)
54-56: Fix grammar and capitalization errors. Line 56 contains a typographical error ("One" → "Once") and inconsistent capitalization ("Click" → "click").Apply this diff:
-One a pipeline run is triggered, Click on **View Logs** and then in the log panel that opens to the right, click on **Stop Run**. +Once a pipeline run is triggered, click on **View Logs** and then in the log panel that opens to the right, click on **Stop Run**.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/introduction.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md(1 hunks)en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md
🧰 Additional context used
🪛 LanguageTool
en/pe-docs/docs/devops/automation-pipelines/introduction.md
[style] ~2-~2: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 530 characters long)
Context: # What are Automation Pipelines !!! info "Note" Automation pipeline cap...
(EN_EXCESSIVE_EXCLAMATION)
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
[style] ~50-~50: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3409 characters long)
Context: ...n the upper-right corner of the panel. !!! info "Note" Choreo keeps pipeline l...
(EN_EXCESSIVE_EXCLAMATION)
[grammar] ~55-~55: Ensure spelling is correct
Context: ...m for 30 days. ## Stop a Pipeline Run One a pipeline run is triggered, Click on *...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
[style] ~12-~12: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1939 characters long)
Context: ...> ``` ## Available Built-in Templates !!! info "Note" The list of built-in te...
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
24-24: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (2)
en/pe-docs/docs/devops/automation-pipelines/introduction.md (1)
1-6: Content is clear and well-structured. The introduction properly sets the scope (private data plane organizations only) and references both the simplified Choreo pipeline syntax and Argo Workflows foundation. The info box and links are well-integrated.en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md (1)
1-82: Well-organized template reference with clear examples. The document structure with collapsible template descriptions, proper YAML syntax highlighting, and the comprehensive Marketplace Publishing example is well-executed. Descriptive link text and proper Jinja escaping ({% raw %}) are in place.
en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
Outdated
Show resolved
Hide resolved
abeykoon
force-pushed
the
add-automation-pipeline-docs
branch
from
2a8a386 to
19b8c24
Compare
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
Outdated
Show resolved
Hide resolved
en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
Outdated
Show resolved
Hide resolved
2 participants
Description
Add documentation related to automation pipelines to PE doc section.
Type of change
Testing
Related issues
https://github.com/wso2-enterprise/choreo/issues/36374
Summary by CodeRabbit