From 28f99cdb6df350428344dca1fc421d285a5d91e7 Mon Sep 17 00:00:00 2001 From: anton Date: Mon, 9 Dec 2024 17:22:36 +0100 Subject: [PATCH] docs(web-modeler): document basic review feature closes https://github.com/camunda/web-modeler/issues/12149 --- .../process-application-pipeline.md | 19 +++++++++++++++---- .../integrate-web-modeler-in-ci-cd.md | 2 +- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/components/modeler/web-modeler/process-application-pipeline.md b/docs/components/modeler/web-modeler/process-application-pipeline.md index d73034131b..b4cea62b06 100644 --- a/docs/components/modeler/web-modeler/process-application-pipeline.md +++ b/docs/components/modeler/web-modeler/process-application-pipeline.md @@ -66,11 +66,22 @@ Play is being rebuilt and progressively rolled out to more users. See [Play limi ## Review -After validation is complete, you can release a version of your process application for review and approval. +After validation is complete, you can mark a version of your process application for review. -- Use [process application versioning](process-application-versioning.md) to track and review changes across the files and assets in the process application. You can [compare milestones](/docs/components/modeler/web-modeler/milestones.md#compare-milestones) to visually review changes between two versions of a BPMN file, or view code changes for other files. -- Use comments to make review collaboration easier. -- Approvers can add a comment to the main process diagram to indicate that a review is complete and that the process application is ready to be promoted to the next stage. +- Use [process application versioning](process-application-versioning.md) to track and review changes across the files and assets in the process application. + You can [compare milestones](/docs/components/modeler/web-modeler/milestones.md#compare-milestones) to visually review changes between two versions of a BPMN file, or view code changes for other files. +- You can request a review for the newest version of the process application from the version history page of the main process. +- Collaborators with edit permission will see a notification on the main process diagram when a review has been requested. +- Reviewers can view the changes, leave a comment, request changes, or approve the process application version. +- After a review has been submitted, the process application version is marked as reviewed and the review status is shown in the version history. A User can go back and edit the review at any point in time. + +This review capability is most useful for reviews on a business level. +For technical reviews it can make sense to use [Git Sync](git-sync.md) to put changes into a technical context with related code changes. + +:::info +Currently anyone who has edit permissions on a process application can perform a review. Users can also review their own changes. +There can only be one open review at a time for a process application. +::: ## Promote diff --git a/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md b/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md index adc30b76c1..a12b6928bc 100644 --- a/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md +++ b/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md @@ -14,7 +14,7 @@ import TabItem from "@theme/TabItem"; [Web Modeler](../../components/modeler/about-modeler.md) serves as a powerful tool for the development and deployment of processes and process applications. While Web Modeler simplifies one-click deployment for development, professional teams often rely on continuous integration and continuous deployment (CI/CD) pipelines for automated production deployments. The [Web Modeler API](/apis-tools/web-modeler-api/index.md) facilitates integration of Web Modeler into these pipelines, aligning with team practices and organizational process governance. -- For low-risk processes, you can use the Web Modeler [process application development pipeline](/docs/components/modeler/web-modeler/process-application-pipeline.md) to quickly develop and progress process application releases through the stages of a standard development lifecycle. [Milestone comparison](/docs/components/modeler/web-modeler/milestones.md#compare-milestones) (Visual and XML diffing) and [Git Sync](/docs/components/modeler/web-modeler/git-sync.md) provide a powerful combination for collaboration between team members using both Web and Desktop Modeler. +- For low-risk processes, you can use the Web Modeler [process application development pipeline](/docs/components/modeler/web-modeler/process-application-pipeline.md) to quickly develop and progress process application releases through the stages of a standard development lifecycle. [Milestone comparison](/docs/components/modeler/web-modeler/milestones.md#compare-milestones) (Visual and XML diffing), built in review, and [Git Sync](/docs/components/modeler/web-modeler/git-sync.md) provide a powerful combination for collaboration between team members using both Web and Desktop Modeler. - For business-critical and higher-risk processes that require strict governance and/or quality requirements, you can integrate Web Modeler into your CI/CD pipelines.