10.1.0 doc cleanup

buildSrc/src/main/java/com/blackduck/integration/detect/docs/content/Terms.java

@@ -11,6 +11,7 @@ public Terms() {
         termMap.put("script_repo_url_bash", "https://detect.blackduck.com/detect10.sh");
         termMap.put("script_repo_url_powershell", "https://detect.blackduck.com/detect10.ps1");
         termMap.put("binary_repo_url_project", "https://repo.blackduck.com/bds-integrations-release/com/blackduck/integration/detect/");
+        termMap.put("binary_repo_url_project_old", "https://repo.blackduck.com/bds-integrations-release/com/synopsys/integration/synopsys-detect/");
         termMap.put("binary_repo_ui_url_project", "https://repo.blackduck.com/bds-integrations-release/com/blackduck/integration/detect/");
         //No UI for repo.blackduck.com as of 2024-09-25
         termMap.put("binary_repo_jenkins_url_project", "https://repo.blackduck.com/bds-integrations-release/com/blackducksoftware/integration/blackduck-detect/");

documentation/src/main/markdown/components/tools.md

@@ -10,7 +10,6 @@ value specified in parentheses are:
 * [Detector](../components/detectors.dita) (--detect.tools=DETECTOR)
 * [Black Duck Signature Scanner](../runningdetect/basics/runningwithblackduck.md) (--detect.tools=SIGNATURE_SCAN)
 * [Black Duck - Binary Analysis](../runningdetect/basics/runningwithblackduck.md) (--detect.tools=BINARY_SCAN)
-* [Vulnerability Impact Analysis Tool](../runningdetect/basics/runningwithblackduck.md) (--detect.tools=IMPACT_ANALYSIS)
 * [IaC Scanner](../runningdetect/basics/runningwithblackduck.md) (--detect.tools=IAC_SCAN)
 * [Container Scan](../runningdetect/containerscanning.md) (--detect.tools=CONTAINER_SCAN)
 * [ReversingLabs Scan](../runningdetect/threatintelscan.md) (--detect.tools=THREAT_INTEL)

documentation/src/main/markdown/currentreleasenotes.md

@@ -1,5 +1,6 @@
 # Current Release notes
 
+**Notice**
 [company_name] [solution_name] has been renamed [detect_product_long] with page links, documentation, and other URLs updated accordingly. Update any [detect_product_short] documentation, or other bookmarks you may have. See the [Domain Change FAQ](https://community.blackduck.com/s/article/Black-Duck-Domain-Change-FAQ).
 * As part of this activity, sig-repo.synopsys.com and detect.synopsys.com are being deprecated. Please make use of repo.blackduck.com and detect.blackduck.com respectively. 
     * After February 2025, [detect_product_short] script download details will only be available via detect.blackduck.com.

documentation/src/main/markdown/integrations/jenkinsplugin/downloadingandinstalling.md

@@ -1,6 +1,6 @@
 # Downloading, Installing, and Updating the Plugin
 
-## Downloading and Installing
+## Downloading and Installing a new instance
 To install the [detect_product_short] for Jenkins plugin, perform the following steps:
 
 1. Navigate to **Manage Jenkins** > **Manage Plugins**.
@@ -10,14 +10,14 @@ To install the [detect_product_short] for Jenkins plugin, perform the following
 1. After restarting Jenkins, confirm that the plugin is successfully installed by navigating to **Manage Jenkins** > **Manage Plugins > Installed**, and verify that **[company_name] [solution_name]** displays in the list.
 
 [detect_product_short] plugin for Jenkins GitHub page [jenkinsci](https://github.com/jenkinsci/blackduck-detect-plugin).
-Additional download locations listed in [Download locations](../../downloadingandrunning/downloadlocations.html).
+Additional download locations listed in [Download locations](../../downloadingandinstalling/downloadlocations.html).
 
-## [company_name] [solution_name] Jenkins plugin to [detect_product_long] Jenkins plugin{#updating-existing-jenkins}
+## Updating [company_name] [solution_name] Jenkins plugin to [detect_product_long] Jenkins plugin{#updating-existing-jenkins}
 For existing [company_name] [solution_name] Jenkins plugin users, the [detect_product_long] Jenkins plugin should be considered a fresh installation as the domain has changed.   
-* Before moving from the [detect_product_short] Jenkins plugin to the [detect_product_long] Jenkins plugin, you should take note of your existing system configuration and post-build setup.   
+* Take note of your existing system configuration and post-build setup before moving from the [detect_product_short] Jenkins plugin to the [detect_product_long] Jenkins plugin. You will need this information when configuring or reconfiguring your pipelines.    
    * Configuration information can be located under your `JENKINS_HOME` directory.   
-* If you are utilizing a [detect_product_short] Post Build Step, before upgrading to the [detect_product_long] plugin, make sure to record the current configuration set in the configurable pipelines.
-   * For Groovy, you will need to update the **Pipeline** script; under **Pipelines** > **Pipeline_Name** > **Configuration**, replacing the `synopsys_detect detectProperties:` portion of the script with `blackduck_detect detectProperties:`
+* If you are utilizing a [detect_product_short] Post Build Step, before upgrading to the [detect_product_long] plugin, make sure to record the current configuration set in the configurable pipelines, for reuse.
+* For Groovy, you will need to update the **Pipeline** script; under **Pipelines** > **Pipeline_Name** > **Configuration**, replacing the `synopsys_detect detectProperties:` portion of the script with `blackduck_detect detectProperties:`
 
    Example:
 ```
@@ -33,7 +33,7 @@ For existing [company_name] [solution_name] Jenkins plugin users, the [detect_pr
 }
 ```
 
-* For the System Configuration and [bd_product_long], before upgrading to the [detect_product_long] plugin, make sure to back up, or record the current configuration set for the [bd_product_short] URL and token that you have set in Manage Jenkins > Configure System > [detect_product_long] section.
+* For the System Configuration and [bd_product_long], before upgrading to the [detect_product_long] plugin, make sure to back up, or record the current configuration set for the Global [bd_product_short] URL and token that you have set in Manage Jenkins > Configure System > [detect_product_long] section.
 * If you are using Air Gap mode, before upgrading to the [detect_product_long] plugin, make sure to save the current tool configuration that you have set in Manage Jenkins > Tools > Detect Air Gap mode.
 
 ## Updating the [detect_product_long] for Jenkins plugin

documentation/src/main/markdown/integrations/jenkinsplugin/jenkins.md

@@ -1,6 +1,6 @@
 # Jenkins Plugin
 
-The [detect_product_short] for Jenkins plugin enables you to install and run [detect_product_short] in your Jenkins instance. 
+The [detect_product_long] for Jenkins plugin enables you to install and run [detect_product_short] in your Jenkins instance. 
 
 [detect_product_short] scans code bases in your projects and folders to perform compositional analysis and functions as a [bd_product_short] intelligent scan client. [detect_product_short] sends scan results to [bd_product_short], which generates risk analysis when identifying open source components, licenses, and security vulnerabilities.
 

documentation/src/main/markdown/integrations/jenkinsplugin/jenkinsrequirements.md

@@ -1,6 +1,6 @@
-# Requirements for [detect_product_short] for Jenkins
+# Requirements for [detect_product_long] for Jenkins
 
-Requirements for [detect_product_short] for Jenkins which may be in addition to those for [detect_product_short].
+Requirements for [detect_product_long] for Jenkins which may be in addition to those for [detect_product_short].
 
 * Access to the internet is required to download components from GitHub and other locations.
 * Minimum 8GB RAM.

documentation/src/main/markdown/integrations/jenkinsplugin/pluginreleasenotes.md

@@ -1,18 +1,18 @@
 # Release Notes for Jenkins Plugin
 
-## **Version 10.0.0**
+## Version 10.0.0
 
 **Notice**
 
 The [company_name] Software Integrity Group is now [var_company_name]    
 * As part of this activity, sig-repo.synopsys.com and detect.synopsys.com are being deprecated and will be decommissioned in Feb. 2025. Please make use of repo.blackduck.com and detect.blackduck.com respectively.    
 * Refer to the [Black Duck Domain Change FAQ](https://community.blackduck.com/s/article/Black-Duck-Domain-Change-FAQ#SDInstru).
-
+<note type="note">It is recommended that customers add both `repo.blackduck.com`, and `detect.blackduck.com`, to their allow list, while also maintaining `sig-repo.synopsys.com`, and `detect.synopsys.com`, until February 2025 when `sig-repo.synopsys.com`, and `detect.synopsys.com`, will be fully replaced by `repo.blackduck.com` and `detect.blackduck.com` respectively.</note>
 [company_name] [solution_name] Jenkins plugin is now the [detect_product_long] Jenkins plugin.
 
 For existing users, the [detect_product_long] Jenkins plugin should be considered a fresh installation as the domain has changed.
-Before moving from the [detect_product_short] Jenkins plugin to the [detect_product_long] Jenkins plugin, you should record your existing system configuration. See additional information about upgrading from the [detect_product_short] Jenkins plugin to the [detect_product_long] Jenkins plugin under [Downloading and Installing.](../jenkinsplugin/downloadingandinstalling.md#updating-existing-jenkins)
-
+   * Prior to moving from the [detect_product_short] Jenkins plugin to the [detect_product_long] Jenkins plugin, you should record your existing system configuration for use reconfiguring your pipelines after installation. 
+   * **Before** installing the [detect_product_long] Jenkins plugin, read the [additional information](../jenkinsplugin/downloadingandinstalling.md#updating-existing-jenkins) about the upgrade process.
 <note type="note">For continued functionality and to receive future updates to the Jenkins plugin, you must upgrade to [detect_product_long] Jenkins plugin version 10.0.0 prior to February 14th, 2025.</note>
 
 If you are a new user, you may proceed with installing the [detect_product_long] Jenkins plugin as per [Downloading and Installing](../jenkinsplugin/downloadingandinstalling.md).    
@@ -21,13 +21,14 @@ If you are a new user, you may proceed with installing the [detect_product_long]
 
 * (IDTCTJNKNS-277) Updated to use the new 'blackduck' namespace.
 * Updated to use [detect_product_long] 10.x.x for execution.
+   * [detect_product_long] [Release Notes](../../currentreleasenotes.md)
 * Jenkins version 2.426.3 or later is required.
 
 **Resolved issues**
 
 * The plugin has been built against upgraded Jenkins/Jenkins plugin versions to mitigate known security risks.
 
-## **Version 9.0.0**
+## Version 9.0.0
 **New features**
 
 * This release is compatible with [company_name] [solution_name] 9.x.x. (Downloading and using detect9.(sh/ps1)).
@@ -45,7 +46,7 @@ If you are a new user, you may proceed with installing the [detect_product_long]
 * (IDTCTJNKNS-263) Updated [company_name] [solution_name] Jenkins Plugin to provide consistent behavior for Linux, and Mac Agent when project names have leading or trailing spaces.
 * (IDTCTJNKNS-272) Updated [company_name] [solution_name] Jenkins Plugin to support passing '&' in the DETECT_SOURCE_PATH property.
 
-## **Version 8.0.1**
+## Version 8.0.1
 **Resolved issues**
 
 * (IDTCTJNKNS-266) Resolved the following issues:
@@ -55,7 +56,7 @@ If you are a new user, you may proceed with installing the [detect_product_long]
 
 <note type="important">Customers running Jenkins version 2.410 and above should upgrade to [company_name] [solution_name] Jenkins plugin 8.0.1</note>
 
-## **Version 8.0.0**
+## Version 8.0.0
 **New features**
 
 * Updated to be compatible with [company_name] [solution_name] 8.x.x. (Downloading and using detect8.(sh/ps1)).
@@ -82,7 +83,7 @@ If you are a new user, you may proceed with installing the [detect_product_long]
 * (IDTCTJNKNS-220) Jenkins Build is changed to Unstable for Invalid values in [company_name] [solution_name] Installers
 * (IDTCTJNKNS-192) Size must be between 1 and 50 when --detect.project.tag is more than 50 characters
 
-## **Version 7.0.0**
+## Version 7.0.0
 **New features**
 
 * Update major version to match major version of [company_name] [solution_name] that it runs.
@@ -95,12 +96,12 @@ If you are a new user, you may proceed with installing the [detect_product_long]
 
 * When using script (sh/ps1), no longer cache the script. Plugin will download the script on each execution.
 
-## **Version 3.1.0**
+## Version 3.1.0
 **New features**
 
 * Added the capability to run [company_name] [solution_name] in Air Gap mode using the [company_name] [solution_name] plugin.
 
-## **Version 3.0.0**
+## Version 3.0.0
 **New features**
 
 * Added capability to turn off automatic escaping by setting the environment variable DETECT\_PLUGIN\_ESCAPING to false.
@@ -116,14 +117,14 @@ If you are a new user, you may proceed with installing the [detect_product_long]
 * Updated the minimum version for Jenkins to 2.150.3.
 * Connection validation is improved when testing through a proxy.
 
-## **Version 2.1.1**
+## Version 2.1.1
 **Resolved issues**
 
 * Resolved an issue wherein [company_name] [solution_name] for Jenkins didn't escape commas correctly in PowerShell arguments. 
 * Resolved an issue wherein [company_name] [solution_name] for Jenkins didn't function when there were spaces in the workspace path resulting in failure to find the shell/PowerShell script. 
 * Version 2.0.2 of the S[company_name] [solution_name] for Jenkins plugin violated semantic versioning by introducing a non-backward compatible change. Updating to any 2.X version from version 2.0.1 or earlier must be done with caution as that update might break existing functionality. 
 
-## **Version 2.1.0**
+## Version 2.1.0
 **New features**
 
 * [company_name] [solution_name] for Jenkins now returns an exit code of 0 for a successful pipeline run.
@@ -135,7 +136,7 @@ If you are a new user, you may proceed with installing the [detect_product_long]
 * Added improvements for working with containers.
 * Verified support for [company_name] [solution_name] Jenkins plugin in the Cloudbees Core environment built with Kubernetes.
 
-## **Version 2.0.2**
+## Version 2.0.2
 **New features**
 
 * Added auto-escaping parameters.
@@ -149,18 +150,18 @@ If you are a new user, you may proceed with installing the [detect_product_long]
 * Resolved an issue wherein a null pointer exception may be thrown when the proxy user name is blank.
 * Resolved in issue wherein the plugin was not properly escaping the path to the PowerShell script.  This also improves handling of elements like random pipes in the path.
 
-## **Version 2.0.1**
+## Version 2.0.1
 **Resolved issues**
 
 * Resolved an issue wherein configuration/connection settings for the plugin are deleted when restarting Jenkins.
 
-## **Version 2.0.0**
+## Version 2.0.0
 **New features**
 
 * You can now run [company_name] [solution_name] for Jenkins by uploading a Detect JAR file.
 * [company_name] [solution_name] for Jenkins now uses the Polaris credentials stored in the credentials plugin in Jenkins.
 
-## **Version 1.5.0**
+## Version 1.5.0
 **Resolved issues**
 
 * Resolved an issue wherein the proxy settings may be ignored when downloading the jar file.
@@ -170,37 +171,37 @@ If you are a new user, you may proceed with installing the [detect_product_long]
 
 * [company_name] [solution_name] for Jenkins now displays in parenthesis the version of Detect packaged with the plugin.
 
-## **Version 1.4.1**
+## Version 1.4.1
 * Maintenance release with overall improvements in stability and security.
 
-## **Version 1.4.0**
+## Version 1.4.0
 * Added support for converting from a Maven project to a Gradle project.
 * Improved error handling for [company_name] [solution_name] exit codes.
 * Addressed an issue wherein cancelling a [company_name] [solution_name] job was not terminating correctly.
 
-## **Version 1.3.0**
+## Version 1.3.0
 * Added support for Java 8.
 * [company_name] [solution_name] for Jenkins now supports Jenkins version 2.60.1 and higher.
 * Added API key support.
 * Added support for Microsoft NT Lan Manager (NTLM) protocol.
 
-## **Version 1.2.0**
+## Version 1.2.0
 * Added support for Java 7.
 * Now includes support for an Artifactory URL override option.
 
-## **Version 1.1.0**
+## Version 1.1.0
 * Added DSL support.
 
-## **Version 1.0.2**
+## Version 1.0.2
 **Resolved Issues**
 
 * Subordinate nodes do not use the proxy to download the [company_name] [solution_name] *.jar* file (potential fix)
 
-## **Version 1.0.1**
+## Version 1.0.1
 **Resolved Issues**
 
 * Resolved an issue wherein *JenkinsProxyHelper.shouldUseProxy* (final URL, final String noProxyHosts) was incorrectly returning *false* if the Hub URL was set, and incorrectly returning *true* when the Hub host name should be ignored.
 * Resolved an issue with the Java executable path.
 
-## **Version 1.0.0**
+## Version 1.0.0
 * First release of product

documentation/src/main/markdown/runningdetect/threatintelscan.md

@@ -23,6 +23,10 @@ Identification of malware displayed to [bd_product_short] users will include fil
  * Must be running [bd_product_short] 2024.4.0 or greater.
  * The [threat_intel] service container (rl-service) must be running.
  * [threat_intel] scans require network connectivity (Air gap mode is not supported).
+    * For more network requirement information please consult the documentation provided by [bd_product_short] under the topic:
+<xref href="Require_Network.dita" scope="peer"> Network requirements
+<data name="facets" value="pubname=bd-hub"/></xref>   
+
  * [threat_intel] scan does not provide project and version name defaults so you need to set project and version names via properties when [threat_intel] is the only tool invoked. (If the specified project or version does not exist in [bd_product_short], it will be created.)
 
 ## Invocation
@@ -36,7 +40,7 @@ To invoke a [threat_intel] scan, which only executes in "Intelligent" mode, the
 
 ## Results
 
-[threat_intel] scan findings will appear in the [bd_product_short] user interface under the **Malware** tab. Further information on viewing [threat_intel] results is available [here](https://documentation.blackduck.com/bundle/bd-hub/page/ComponentDiscovery/aboutReversinglabsScanning.html)
+[threat_intel] scan findings will appear in the [bd_product_short] user interface under the **Malware** tab. Further information on viewing [threat_intel] results is available [here](https://documentation.blackduck.com/bundle/bd-hub/page/ComponentDiscovery/aboutReversinglabsScanning.html).
 
 ## Further information
-For additional information regarding the related properties, see [threat-intel](../properties/configuration/threat-intel.md)
+For additional information regarding the related properties, see [threat-intel](../properties/configuration/threat-intel.md).

documentation/src/main/resources/templates/downloadlocations.ftl

@@ -4,8 +4,10 @@ The following are download locations for the current version of [detect_product_
 
 * [detect_product_short] Bash script: [Bash script](${script_repo_url_bash})
 * The [detect_product_short] PowerShell script: [PowerShell script](${script_repo_url_powershell})
-* The [detect_product_short] binary repository (.jar and air gap zip files): [Binary files](${binary_repo_url_project})
-* The [detect_product_short] repository for the Jenkins plugin: [Release Artifacts Repository](${binary_repo_jenkins_url_project})
+* The [detect_product_short] binary repository (.jar and air gap zip files) for 10.0.0 and later: [Binary files](${binary_repo_url_project})
+* The [detect_product_short] binary repository (.jar and air gap zip files) for 9.10.1 and earlier: [Binary files](${binary_repo_url_project_old})
+* [detect_product_long] Jenkins plugin is available here: [Jenkins plugin](https://plugins.jenkins.io/blackduck-detect/)
+* The [detect_product_long] extension for Azure DevOps is available on the: [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=blackduck.blackduck-detect)
 
 **Note:** For certain types of projects, [detect_product_short] automatically downloads one or more [inspectors](../components/inspectors.md) as needed.
 * In air-gap environments you may need to download the [var_product_sigma] scanner at the following location: [Sigma](${binary_repo_url_sigma})

documentation/topics.ditamap

@@ -7,7 +7,7 @@
 		<prodinfo>
 			<prodname>Black Duck Detect</prodname>
 			<vrmlist>
-				<vrm version="10.0.0"/>
+				<vrm version="10.1.0"/>
 			</vrmlist>
 		</prodinfo>
 		<!-- zoomin bundle name -->