doc(impact-analysis): Added some doc to indicate the impact analysis …

…can be enabled.
blackducksoftware · Jul 21, 2020 · b008def · b008def
1 parent bfdef88
commit b008def
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/buildSrc/src/main/java/com/synopsys/integration/detect/docs/content/Terms.java b/buildSrc/src/main/java/com/synopsys/integration/detect/docs/content/Terms.java
@@ -54,9 +54,10 @@ public Terms() {
         termMap.put("polaris_product_name", "Polaris");
         termMap.put("dockerinspector_name", "Black Duck Docker Inspector");
         termMap.put("blackduck_kb", "Black Duck KnowledgeBase");
+        termMap.put("impact_analysis_name", "Vulnerability Impact Analysis Tool");
     }
 
-    public String put(final String termKey, final String replacementString) {
+    public String put(String termKey, String replacementString) {
         return termMap.put(termKey, replacementString);
     }
 

diff --git a/docs/templates/content/30-running.ftl b/docs/templates/content/30-running.ftl
@@ -176,6 +176,7 @@ project directory.
 ${solution_name} can be configured to perform additional tasks, including the following:
 
 * Enable any of the supported snippet matching modes in the [${blackduck_signature_scanner_name}](../properties/configuration/signature scanner/).
+* Enable the [${impact_analysis_name}](../components/tools/) on any Java project.
 * Run [${blackduck_binary_scan_capability}](../properties/configuration/signature scanner/#binary-scan-target) on a given binary files.
 * Run the ${dockerinspector_name} on a given [Docker image](../advanced/package-managers/docker-images/).
 * Generate a [report](../properties/configuration/report/).

diff --git a/docs/templates/content/components/tools.ftl b/docs/templates/content/components/tools.ftl
@@ -2,7 +2,7 @@
 
 Each ${solution_name} run consists of running any applicable ${solution_name} tools.
 
-The available ${solution_name} tools in order of execution, with the corresponding [detect tools property](../../properties/configuration/paths/#detect-tools-included-advanced)
+The available ${solution_name} tools in order of execution, with the corresponding [detect tools property](../../properties/configuration/paths/#detect-tools-included)
 value specified in parentheses are:
 
 * [${polaris_product_name}](../../30-running/#running-with-polaris) (--detect.tools=POLARIS)
@@ -11,5 +11,6 @@ value specified in parentheses are:
 * [Detector](../detectors/) (--detect.tools=DETECTOR)
 * [${blackduck_signature_scanner_name}](../../30-running/#running-with-black-duck) (--detect.tools=SIGNATURE_SCAN)
 * [${blackduck_binary_scan_capability}](../../30-running/#running-with-black-duck) (--detect.tools=BINARY_SCAN)
+* [${impact_analysis_name}](../../30-running/#running-with-black-duck) (--detect.tools=IMPACT_ANALYSIS)
 
 The detector tool runs any applicable [detectors](../detectors/).