Merge pull request #497 from jmanojhcl/main

Made some minor changes for consistency
UrbanCode · Nov 7, 2024 · b9171a6 · b9171a6
2 parents 20d0f80 + 182aeba
commit b9171a6
Show file tree

Hide file tree

Showing 8 changed files with 46 additions and 10 deletions.
diff --git a/docs/UCV/ucv-ext-coverage-core/overview.md b/docs/UCV/ucv-ext-coverage-core/overview.md
@@ -8,7 +8,10 @@ request.
 
 ## Compatibility
 
-Must be running IBM DevOps Velocity version 1.2.1 and later to use this plug-in.
+The plugin is compatible with following versions:
+
+- IBM UrbanCode Velocity 2.0.x to IBM UrbanCode Velocity 4.0.x
+- IBM DevOps Velocity 5.0.x or later
 
 
 ## Versions

diff --git a/docs/UCV/ucv-ext-coverage-core/usage.md b/docs/UCV/ucv-ext-coverage-core/usage.md
@@ -11,7 +11,7 @@ To use the Code Coverage plug-in, the plug-in must be loaded, and an instance cr
 
 ## Integration type
 
-The Code Coverage plug-in is a parser type plugin and it parses data from the following test tools:
+The Code Coverage plug-in is a parser type plug-in and it parses data from the following test tools:
 
 * LCOV
 * Cobertura
@@ -20,13 +20,13 @@ The Code Coverage plug-in is a parser type plugin and it parses data from the fo
 
 ## Invoking the plug-in
 
-You can invoke the plug-in manually using a REST Call or by [using a Jenkins plug-in](#invokejenkins) to integrate DevOps Velocity in a Jenkins environment.
+You can invoke the plug-in manually using a REST Call or by [using a Jenkins plug-in](#invokejenkins) to integrate IBM DevOps Velocity in a Jenkins environment.
 
 ### Invoke using Jenkins plug-in
 
-Install the [DevOps Velocity plug-in](https://plugins.jenkins.io/urbancode-velocity) into
-your Jenkins server. In your freestyle job or pipeline use the **UCV-Upload Metrics File to DevOps Velocity** step
-and provide the required fields. This step allows your build job to upload generated coverage results files to UrbanCode
+Install the [IBM DevOps Velocity plug-in](https://plugins.jenkins.io/urbancode-velocity) into
+your Jenkins server. In your freestyle job or pipeline use the **UCV-Upload Metrics File to IBM DevOps Velocity** step
+and provide the required fields. This step allows your build job to upload generated coverage results files to IBM DevOps
 Velocity.
 
 #### Example

diff --git a/docs/UCV/ucv-ext-cypress/overview.md b/docs/UCV/ucv-ext-cypress/overview.md
@@ -7,6 +7,13 @@ You can now easily explore the functional test results in IBM DevOps Velocity wi
 
 Cypress plug-in helps in visualizing the functional test results in intuitive graphs, enabling rapid feedback, trend analysis, and informed decision-making for development teams.
 
+## Compatibility
+
+The plugin is compatible with following versions:
+
+IBM UrbanCode Velocity 2.0.x to IBM UrbanCode Velocity 4.0.x
+IBM DevOps Velocity 5.0.x or later
+
 ## Versions
 
 IBM DevOps Velocity plug-in images are located in DockerHub. To

diff --git a/docs/UCV/ucv-ext-milestone-risk-estimator/overview.md b/docs/UCV/ucv-ext-milestone-risk-estimator/overview.md
@@ -4,13 +4,18 @@
 
 Milestone risk estimator plug-in for IBM DevOps Velocity estimates value stream management sprint risk and provides estimated result in metrics **P.R.E Risk** (Probabilistic Risk Estimator) which shows the evaluated risk as percentage and **P.R.E Deadline** (Probabilistic Risk Estimator) which shows an estimated deadline. There are two scheduled events ExecuteTrain and ExecutePrediction. ExecuteTrain is for training the model and ExecutePrediction is for predicting the risk of current active sprint. It collects work item data and use them to train the model and predict the risk. The default training frequency is a week and default prediction frequency is a day. Any closed work items are queried for training and open work items of active sprint are queried and used for predicting the risk. At the end of every prediction, the prediction results are inserted as metrics.
 
-## Compatability
+## Compatibility
 
-Must be running IBM DevOps Velocity version 5.0.0 and later to use the plug-in.
+The plugin is compatible with following versions:
+
+- IBM DevOps Velocity 5.0.0 or later
 
 
 ## Versions
 
+IBM DevOps Velocity plug-in images are located in DockerHub. To
+view available versions, see the [UrbanCode DockerHub](https://hub.docker.com/r/urbancode/ucv-ext-milestone-risk-estimator/tags).
+
 ### History
 
 ### Version 2.0.2

diff --git a/docs/UCV/ucv-ext-njs-unit/overview.md b/docs/UCV/ucv-ext-njs-unit/overview.md
@@ -7,6 +7,13 @@ The Njs-Unit plugin helps you to upload the unit test results data to the IBM De
 
 This visualization will help you to understand passed or failed trends and analyze for further better quality assurance in a unit test level.
 
+## Compatibility
+
+The plugin is compatible with following versions:
+
+- IBM UrbanCode Velocity 2.0.x to IBM UrbanCode Velocity 4.0.x
+- IBM DevOps Velocity 5.0.x or later
+
 ## Versions
 
 IBM DevOps Velocity plug-in images are located in DockerHub. To

diff --git a/docs/UCV/ucv-ext-release-summary-ibm/overview.md b/docs/UCV/ucv-ext-release-summary-ibm/overview.md
@@ -6,6 +6,12 @@ The AI summary provides real-time updates as issue data changes, enhancing produ
 
 Note: The plug-in currently supports only English language and may not provide accurate summary for the poorly documented issues that are part of the release.
 
+## Compatibility
+
+The plugin is compatible with following versions:
+
+IBM DevOps Velocity 5.0.8 or later
+
 ## Business Use Case
 
 GenAI Summary Release–IBM plug-in enhances the release candidate phase by automatically generating clear, concise summaries based on detailed issue descriptions. This accelerates decision-making and improves efficiency by translating complex issue details into actionable insights. With real-time, contextually relevant summaries, the plug-in ensures consistent communication, helping teams quickly prioritize and resolve critical issues, ultimately leading to a smoother release process and higher-quality software.

diff --git a/docs/UCV/ucv-ext-release-summary-openai/overview.md b/docs/UCV/ucv-ext-release-summary-openai/overview.md
@@ -6,6 +6,12 @@ The AI summary provides real-time updates as issue data changes, enhancing produ
 
 Note: The plug-in currently supports only English language and may not provide accurate summary for the poorly documented issues that are part of the release.
 
+## Compatibility
+
+The plugin is compatible with following versions:
+
+- IBM DevOps Velocity 5.0.8 or later
+
 ## Business Use Case
 
 GenAI Summary Release-OpenAI plug-in enhances the release candidate phase by automatically generating clear, concise summaries based on detailed issue descriptions. This accelerates decision-making and improves efficiency by translating complex issue details into actionable insights. With real-time, contextually relevant summaries, the plug-in ensures consistent communication, helping teams quickly prioritize and resolve critical issues, ultimately leading to a smoother release process and higher-quality software.

diff --git a/docs/UCV/ucv-ext-servicenow/overview.md b/docs/UCV/ucv-ext-servicenow/overview.md
@@ -5,8 +5,10 @@ The ServiceNow plug-in provides for integration with a ServiceNow server. This p
 
 ## Compatibility
 
-IBM DevOps Velocity 5.0.0 or later
-IBM UrbanCode Velocity 2.0 to IBM DevOps Velocity 4.0.x
+The plugin is compatible with following versions:
+
+IBM UrbanCode Velocity 2.0.x to IBM UrbanCode Velocity 4.0.x
+IBM DevOps Velocity 5.0.x or later
 
 ## Versions