Merge pull request #1647 from blackducksoftware/cp_reorg

cpottsbd · web-flow · commit 36709ec24fe2 · 2026-02-05T14:54:34.000-05:00
TOC re-org
diff --git a/documentation/src/main/markdown/components/overview.md b/documentation/src/main/markdown/components/overview.md
@@ -1,4 +1,4 @@
-# [detect_product_long] Components
+# [detect_product_short] Components
 
 This topic introduces the components in [detect_product_short] that are used to examine your code and produce analyzable output.
 
diff --git a/documentation/src/main/markdown/components/tools.md b/documentation/src/main/markdown/components/tools.md
@@ -1,6 +1,6 @@
 # Tools
 
-Each [detect_product_long] run consists of running any applicable [detect_product_short] tools.
+Each [detect_product_short] run consists of running any applicable [detect_product_short] tools.
 
 The available [detect_product_short] tools in order of potential execution, with the corresponding [detect tools property](../properties/configuration/paths.md#detect-tools-included)
 value specified in parentheses are:
diff --git a/documentation/src/main/markdown/configuring/overview.md b/documentation/src/main/markdown/configuring/overview.md
@@ -1,4 +1,4 @@
-# Configuring [detect_product_long]
+# Configuring [detect_product_short]
 
 [detect_product_short] is generally configured by assigning values to properties. See the left-hand documentation menu for further information including additional configuration means and methods.
 
diff --git a/documentation/src/main/markdown/downloadingandinstalling/intro.md b/documentation/src/main/markdown/downloadingandinstalling/intro.md
@@ -1,4 +1,4 @@
-# Downloading and Installing [detect_product_long]
+# Downloading and Installing [detect_product_short]
 
 This section describes the process of downloading, verifying, and installing [detect_product_short].
 
diff --git a/documentation/src/main/markdown/downloadingandinstalling/selfupdatingdetect.md b/documentation/src/main/markdown/downloadingandinstalling/selfupdatingdetect.md
@@ -1,4 +1,4 @@
-# [detect_product_long] Version Management
+# [detect_product_short] Version Management
 
 [detect_product_short] self-updating feature will allow customers who choose to enable Centralized [detect_product_short] Version Management in [bd_product_short] to automate the update of [detect_product_short] across their pipelines.
 
diff --git a/documentation/src/main/markdown/downloadingandinstalling/upgradingdetect.md b/documentation/src/main/markdown/downloadingandinstalling/upgradingdetect.md
@@ -1,6 +1,6 @@
-# Upgrading [detect_product_long]
+# Upgrading [detect_product_short]
 
-We recommend reading the release notes for each new [detect_product_long] version.
+We recommend reading the release notes for each new [detect_product_short] version.
 
 [detect_product_short] version names follow [semantic versioning](https://semver.org/). Version strings follow the pattern MAJOR.MINOR.PATCH, with the following implications:
 
diff --git a/documentation/src/main/markdown/downloadingandinstalling/verification.md b/documentation/src/main/markdown/downloadingandinstalling/verification.md
@@ -1,6 +1,6 @@
-# [detect_product_long] Code Verification
+# [detect_product_short] Code Verification
 
-Two methods are available to verify that the [detect_product_long] code you run has not been tampered with since it was built:
+Two methods are available to verify that the [detect_product_short] code you run has not been tampered with since it was built:
 code signature verification and checksum verification.
 Both methods apply to the [detect_product_short] .jar file, and only offer protection when you run
 [detect_product_short] by invoking the [detect_product_short] .jar file directly (as opposed to invoking [bash_script_name] or [powershell_script_name]).
diff --git a/documentation/src/main/markdown/gettingstarted/configuring.md b/documentation/src/main/markdown/gettingstarted/configuring.md
@@ -1,6 +1,6 @@
 # [detect_product_short] configuration overview
 
-What [detect_product_long] looks at and how it performs analysis depends on how it is configured.
+What [detect_product_short] looks at and how it performs analysis depends on how it is configured.
 
 <note type="note">For accurate SCA analysis, [detect_product_short] should typically be executed as a post-build step in the native build environment.</note>
 
diff --git a/documentation/src/main/markdown/gettingstarted/howitworks.md b/documentation/src/main/markdown/gettingstarted/howitworks.md
@@ -1,4 +1,4 @@
-# How [detect_product_long] Works
+# How [detect_product_short] Works
 
 This page provides an overview of how [detect_product_long] works.
 
diff --git a/documentation/src/main/markdown/gettingstarted/overview.md b/documentation/src/main/markdown/gettingstarted/overview.md
@@ -1,4 +1,4 @@
-# Getting started with [detect_product_long]
+# Getting started with [detect_product_short]
 
 Before you start using [detect_product_short], it is recommended that you become familiar with the makeup of [detect_product_short] and how it works. Review the 'Getting started with [detect_product_short]' pages listed in the left-hand menu, to learn about, and prepare to start using [detect_product_short].
 
diff --git a/documentation/src/main/markdown/gettingstarted/phases.md b/documentation/src/main/markdown/gettingstarted/phases.md
@@ -1,4 +1,4 @@
-# [detect_product_long] Processing
+# [detect_product_short] Processing
 
 [detect_product_short] processing can be broken into the following phases:
 
diff --git a/documentation/src/main/markdown/gettingstarted/quickstart.md b/documentation/src/main/markdown/gettingstarted/quickstart.md
@@ -1,6 +1,6 @@
 # [detect_product_short] Quickstart guide
 
-The following is a simple example to help you get started using [detect_product_long].
+The following is a simple example to help you get started using [detect_product_short].
 
 <note type="hint">For another quick path to scanning with [detect_product_short], see [Autonomous Scanning](../runningdetect/autonomousscan.dita).</note>
 
diff --git a/documentation/src/main/markdown/gettingstarted/requirements.md b/documentation/src/main/markdown/gettingstarted/requirements.md
@@ -1,4 +1,4 @@
-# [detect_product_long] requirements and release information
+# [detect_product_short] requirements and release information
 
 ## General requirements
      
diff --git a/documentation/src/main/markdown/gettingstarted/usersandroles.md b/documentation/src/main/markdown/gettingstarted/usersandroles.md
@@ -1,6 +1,6 @@
 # User role requirements when running with [blackduck_product_name]
 
-Any user can download [detect_product_long] and run a scan, however you must configure a user/API token in [bd_product_short] for the [detect_product_short] scan to be analyzed by [bd_product_short].  
+Any user can download [detect_product_short] and run a scan, however you must configure a user/API token in [bd_product_short] for the [detect_product_short] scan to be analyzed by [bd_product_short].  
  
 For more information on creating a [bd_product_short] user token, please consult the documentation provided by [bd_product_short] under the topic:
 <xref href="MyAccessTokens.dita" scope="peer"> Managing user access tokens.
diff --git a/documentation/src/main/markdown/gettingstarted/workflow.md b/documentation/src/main/markdown/gettingstarted/workflow.md
@@ -1,6 +1,6 @@
-# [detect_product_long] basic workflow
+# [detect_product_short] basic workflow
 
-Using [detect_product_long] to analyze your code typically involves the following basic steps:
+Using [detect_product_short] to analyze your code typically involves the following basic steps:
 
 1. Satisfy system and other execution requirements
 1. Download [detect_product_short]
diff --git a/documentation/src/main/markdown/integrations/integrations.md b/documentation/src/main/markdown/integrations/integrations.md
@@ -1,6 +1,6 @@
-# [detect_product_long] Integrations
+# [detect_product_short] Integrations
 
-The [detect_product_long] integrations allow users to install and run [detect_product_short] in various environments.
+The [detect_product_short] integrations allow users to install and run [detect_product_short] in various environments.
 
 [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.
 
diff --git a/documentation/src/main/markdown/runningdetect/basics/choosingrunmethod.md b/documentation/src/main/markdown/runningdetect/basics/choosingrunmethod.md
@@ -1,6 +1,6 @@
 # Choosing a run method (script, .jar, or Docker container)
 
-There are three ways to run [detect_product_long]:
+There are three ways to run [detect_product_short]:
 
 1. Download and run a [detect_product_short] [script](runningscript.md).
 1. Download and run a [detect_product_short] [.jar file](runningjar.md).
diff --git a/documentation/src/main/markdown/runningdetect/basics/choosingtargettype.md b/documentation/src/main/markdown/runningdetect/basics/choosingtargettype.md
@@ -1,13 +1,10 @@
-# Choosing the target type
+# Choosing the Detect target type
 
-[detect_product_long] will select a workflow based in part on the target type you select via the *detect.target.type* property.
+[detect_product_short] will select a workflow based in part on the target type you select via the [detect.target.type](../../properties/all-properties.md) property.
 
-When running [detect_product_short] on project source code, you'll probably want to
-set *detect.target.type* to *SOURCE*, or leave *detect.target.type* unset (since
-*SOURCE* is the default value).
+When running [detect_product_short] on project source code, you can set *detect.target.type* to *SOURCE*, or leave *detect.target.type* unset (since *SOURCE* is the default value).
 
-When running [detect_product_short] on a Docker image, you'll probably want to
-set *detect.target.type* to *IMAGE*.
+When running [detect_product_short] on a Docker image, you will want to set *detect.target.type* to *IMAGE*.
 
 ## Common workflows
 
diff --git a/documentation/src/main/markdown/runningdetect/basics/choosingworkingdir.md b/documentation/src/main/markdown/runningdetect/basics/choosingworkingdir.md
@@ -1,5 +1,5 @@
 # Choosing the working directory
 
-You can run [detect_product_long] from any directory. If you are not running [detect_product_short] from the project directory,
+You can run [detect_product_short] from any directory. If you are not running [detect_product_short] from the project directory,
 provide the project directory using the [source path property](../../properties/configuration/paths.md#source-path). When that property is not set,
 [detect_product_short] assumes the current working directory is the project directory.
diff --git a/documentation/src/main/markdown/runningdetect/basics/decidinghowtouse.md b/documentation/src/main/markdown/runningdetect/basics/decidinghowtouse.md
@@ -1,4 +1,4 @@
-# Deciding how to use [detect_product_long]
+# Deciding how to use [detect_product_short]
 
 Before you download and run [detect_product_short], you should make the following decisions:
 
diff --git a/documentation/src/main/markdown/runningdetect/basics/manual.md b/documentation/src/main/markdown/runningdetect/basics/manual.md
@@ -1,6 +1,6 @@
 # Installation Best Practices
 
-Manually installing [detect_product_long] ensures that the running version is compatible with your environment. Invoking [detect_product_short] with the bash and powershell scripts is easy but automatically downloaded updates may not be compatible with your environment.  
+Manually installing [detect_product_short] ensures that the running version is compatible with your environment. Invoking [detect_product_short] with the bash and powershell scripts is easy but automatically downloaded updates may not be compatible with your environment.  
 
 The best practice for resilience is to add [detect_product_short] on the path, allowing for an easier invocation than even the bash and powershell scripts. It still allows easy updating without modifying commands just as the bash and powershell scripts do. This is the recommended best practice approach when resiliency is required.  
 
diff --git a/documentation/src/main/markdown/runningdetect/basics/positioning.md b/documentation/src/main/markdown/runningdetect/basics/positioning.md
@@ -1,4 +1,4 @@
-# Positioning [detect_product_long] in the build process
+# Positioning [detect_product_short] in the build process
 
 For best results, execute [detect_product_short] post-build step in the build environment of the project.
 Building your project prior to running [detect_product_short] is required for many detectors to run successfully,
diff --git a/documentation/src/main/markdown/runningdetect/basics/runningjar.md b/documentation/src/main/markdown/runningdetect/basics/runningjar.md
@@ -1,4 +1,4 @@
-# Running the [detect_product_long] .jar
+# Running the [detect_product_short] .jar
 
 Recent versions of the [detect_product_short] .jar file are available for download from the location specified in [download locations](../../downloadingandinstalling/downloadlocations.md).
 
@@ -11,8 +11,8 @@ java -jar {path to .jar file}
 For example:
 
 ````
-curl -O https://repo.blackduck.com/bds-integrations-release/com/blackduck/integration/detect/11.0.0/detect-11.0.0.jar
-java -jar detect-11.0.0.jar
+curl -O https://repo.blackduck.com/bds-integrations-release/com/blackduck/integration/detect/11.3.0/detect-11.3.0.jar
+java -jar detect-11.3.0.jar
 ````
 
 You can use the [detect_product_short] Bash script ([bash_script_name]) to download the [detect_product_short] .jar file:
diff --git a/documentation/src/main/markdown/runningdetect/basics/runningscript.md b/documentation/src/main/markdown/runningdetect/basics/runningscript.md
@@ -1,6 +1,6 @@
-# Running the [detect_product_long] script
+# Running the [detect_product_short] script
 
-The primary function of the [detect_product_long] scripts is to download and execute the [detect_product_short] .jar file.
+The primary function of the [detect_product_short] scripts is to download and execute the [detect_product_short] .jar file.
 Several aspects of script functionality can be configured, including:
 
 * The [detect_product_short] version to download/run; by default, the latest version.
@@ -69,10 +69,10 @@ set DETECT_LATEST_RELEASE_VERSION={Detect version}
 powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect"
 ````
 
-For example, to run [detect_product_short] version 11.0.0:
+For example, to run [detect_product_short] version 11.3.0:
 
 ````
-set DETECT_LATEST_RELEASE_VERSION=11.0.0
+set DETECT_LATEST_RELEASE_VERSION=11.3.0
 powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect"
 ````
 
diff --git a/documentation/src/main/markdown/runningdetect/basics/runningwithblackduck.md b/documentation/src/main/markdown/runningdetect/basics/runningwithblackduck.md
@@ -1,6 +1,6 @@
 # Running with [bd_product_long]
 
-[detect_product_long] can be used with multiple [bd_product_short] platforms to perform Software Composition Analysis (SCA).
+[detect_product_short] can be used with multiple [bd_product_short] platforms to perform Software Composition Analysis (SCA).
 
 ## Overview
 
diff --git a/documentation/src/main/markdown/runningdetect/includingexcluding/intro.md b/documentation/src/main/markdown/runningdetect/includingexcluding/intro.md
@@ -1,5 +1,4 @@
-# Including and excluding Tools, Detectors, Directories, and more.
+# Including and excluding Tools, Detectors, and Directories
 
-[Properties](../../properties/all-properties.md) provide a variety of additional options for configuring [detect_product_long] behavior. One of the
-most fundamental ways to modify [detect_product_short] is by including and excluding [tools](../../components/tools.md) and [detectors](../../components/detectors.dita).
+[Properties](../../properties/all-properties.md) provide options for configuring [detect_product_long] behavior. The primary means by which to modify [detect_product_short] output is by including and excluding [tools](../../components/tools.md) and [detectors](../../components/detectors.dita).
 
diff --git a/documentation/src/main/markdown/runningdetect/intro.md b/documentation/src/main/markdown/runningdetect/intro.md
@@ -1,5 +1,5 @@
-# Planning and running [detect_product_long]
+# Planning and running [detect_product_short]
 
-This section describes the basics of planning your installation, configuring your workflow, and running [detect_product_long].
+This section describes the basics of planning your installation, configuring your workflow, and running [detect_product_short].
 
 Refer to the topics in the table of contents for information regarding the ways that [detect_product_short] can be used, the types of scans it supports, and how to best run the application in your environment.
diff --git a/documentation/src/main/markdown/runningdetect/runincontainer.md b/documentation/src/main/markdown/runningdetect/runincontainer.md
@@ -1,6 +1,6 @@
-# Running [detect_product_short] from within a Docker container
+# Running [detect_product_short] within a Docker container
 
-[detect_product_long] publishes Docker images which can be used to run [detect_product_short] from within a Docker container.
+[detect_product_short] publishes Docker images which can be used to run [detect_product_short] from within a Docker container.
 
 [detect_product_short] Docker images are published to `hub.docker.com` and `repo.blackduck.com`.
 
diff --git a/documentation/src/main/markdown/runningdetect/runningairgap.md b/documentation/src/main/markdown/runningdetect/runningairgap.md
@@ -1,6 +1,6 @@
-# Running [detect_product_long] in air gap mode
+# Running [detect_product_short] in air gap mode
 
-Running [detect_product_long] in air gap mode requires adding scanners, inspectors, and associated libraries to a jar file such that they can be executed without network access.
+Running [detect_product_short] in air gap mode requires adding scanners, inspectors, and associated libraries to a jar file such that they can be executed without network access.
 
 <note type="note">Air gap mode is not the same as running in Offline mode. Air gap mode allows for scanning when operating in an air gapped environment and relies on a jar file that contains the required scanning libraries. Offline mode is used when you do not wish to download scanners or upload results files directly to [bd_product_short], but still supports the use of a local signature scanner instance.</note>
 
diff --git a/documentation/src/main/resources/templates/status-file.ftl b/documentation/src/main/resources/templates/status-file.ftl
@@ -1,4 +1,4 @@
-# Status File
+# Output Status File
 
 [detect_product_long] creates an output status file in the run folder with the name "status.json" which contains a summary of the [detect_product_short] run in a machine readable format.
 
@@ -46,7 +46,7 @@ The file includes status codes, issues encountered and results produced. As addi
 <path>". ]
 }
 ```
-## #Detector Status Codes
+## Detector Status Codes
 | Status Code | Description |
 | --- | --- |
 <#list statusCodes as statusCode>
diff --git a/documentation/topics.ditamap b/documentation/topics.ditamap
@@ -7,7 +7,7 @@
 		<prodinfo>
 			<prodname>Black Duck Detect</prodname>
 			<vrmlist>
-				<vrm version="11.2.0"/>
+				<vrm version="11.3.0"/>
 			</vrmlist>
 		</prodinfo>
 		<!-- zoomin bundle name -->
@@ -73,14 +73,13 @@
 	<topicref href="runningdetect/intro.md" format="markdown">
 			<topicref href="runningdetect/basics/decidinghowtouse.md" format="markdown"/>
 			<topicref href="runningdetect/basics/positioning.md" format="markdown"/>
+			<topicref href="runningdetect/basics/manual.md" format="markdown"/>
 			<topicref href="runningdetect/basics/choosingworkingdir.md" format="markdown"/>
 			<topicref href="runningdetect/basics/choosingrunmethod.md" format="markdown"/>
-			<topicref href="runningdetect/basics/manual.md" format="markdown"/>
 			<topicref href="runningdetect/basics/runningscript.md" format="markdown"/>
 			<topicref href="runningdetect/basics/runningjar.md" format="markdown"/>
 			<topicref href="runningdetect/basics/choosingtargettype.md" format="markdown"/>
 			<topicref href="runningdetect/basics/runningwithblackduck.md" format="markdown"/>
-		
 		<topicref href="runningdetect/includingexcluding/intro.md" format="markdown">
 			<topicref href="runningdetect/includingexcluding/tools.md" format="markdown"/>
 			<topicref href="runningdetect/includingexcluding/detectors.md" format="markdown"/>
@@ -154,15 +153,21 @@
 			<topicref href="properties/configuration/binary-scanner.md" format="markdown"/>
 			<topicref href="properties/configuration/blackduck-server.md" format="markdown"/>
 			<topicref href="properties/configuration/cleanup.md" format="markdown"/>
+			<topicref href="properties/configuration/container-scanner.md" format="markdown"/>
 			<topicref href="properties/configuration/debug.md" format="markdown"/>
 			<topicref href="properties/configuration/default.md" format="markdown"/>
 			<topicref href="properties/configuration/detector.md" format="markdown"/>
 			<topicref href="properties/configuration/general.md" format="markdown"/>
+			<topicref href="properties/configuration/global.md" format="markdown"/>
+			<topicref href="properties/configuration/iac-scan.md" format="markdown"/>
 			<topicref href="properties/configuration/impact-analysis.md" format="markdown"/>
 			<topicref href="properties/configuration/logging.md" format="markdown"/>
 			<topicref href="properties/configuration/paths.md" format="markdown"/>
 			<topicref href="properties/configuration/project.md" format="markdown"/>
+			<topicref href="properties/configuration/project-inspector.md" format="markdown"/>
 			<topicref href="properties/configuration/proxy.md" format="markdown"/>
+			<topicref href="properties/configuration/quack-patch.md" format="markdown"/>
+			<topicref href="properties/configuration/rapid-scan.md" format="markdown"/>
 			<topicref href="properties/configuration/report.md" format="markdown"/>
 			<topicref href="properties/configuration/signature-scanner.md" format="markdown"/>
 		</topicref>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# [detect_product_long] Components`
	`1`	`+# [detect_product_short] Components`
`2`	`2`
`3`	`3`	`This topic introduces the components in [detect_product_short] that are used to examine your code and produce analyzable output.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Configuring [detect_product_long]`
	`1`	`+# Configuring [detect_product_short]`
`2`	`2`
`3`	`3`	`[detect_product_short] is generally configured by assigning values to properties. See the left-hand documentation menu for further information including additional configuration means and methods.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Downloading and Installing [detect_product_long]`
	`1`	`+# Downloading and Installing [detect_product_short]`
`2`	`2`
`3`	`3`	`This section describes the process of downloading, verifying, and installing [detect_product_short].`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# [detect_product_long] Version Management`
	`1`	`+# [detect_product_short] Version Management`
`2`	`2`
`3`	`3`	`[detect_product_short] self-updating feature will allow customers who choose to enable Centralized [detect_product_short] Version Management in [bd_product_short] to automate the update of [detect_product_short] across their pipelines.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# How [detect_product_long] Works`
	`1`	`+# How [detect_product_short] Works`
`2`	`2`
`3`	`3`	`This page provides an overview of how [detect_product_long] works.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Getting started with [detect_product_long]`
	`1`	`+# Getting started with [detect_product_short]`
`2`	`2`
`3`	`3`	`Before you start using [detect_product_short], it is recommended that you become familiar with the makeup of [detect_product_short] and how it works. Review the 'Getting started with [detect_product_short]' pages listed in the left-hand menu, to learn about, and prepare to start using [detect_product_short].`
`4`	`4`