Skip to content

Commit f9a7a2e

Browse files
authored
Merge pull request #1031 from blackducksoftware/cp_IDETECT-4185_doc
cp_IDETECT-4185_doc updates
2 parents 5af97f8 + ab238a0 commit f9a7a2e

File tree

3 files changed

+14
-16
lines changed

3 files changed

+14
-16
lines changed

README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@ For AirGap, please use our [Artifactory](https://sig-repo.synopsys.com/webapp/#/
3434

3535
The latest quickstart documentation is [here](https://sig-product-docs.synopsys.com/bundle/integrations-detect/page/gettingstarted/quickstart.html).
3636

37-
The latest full documentation is [here](https://sig-product-docs.synopsys.com/bundle/integrations-detect/page/introduction.html).
38-
39-
Links to certain earlier versions can be found [here](https://community.synopsys.com/s/user-guide-archive).
37+
The latest full documentation and archived documentation in PDF format is [here](https://sig-product-docs.synopsys.com/bundle/integrations-detect/page/introduction.html).
4038

4139
## Getting help
4240

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

+11-11
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
An inspector is typically a plugin that a [solution_name] detector uses to access the internal resources of a package manager through its API.
44

5-
There are currently three inspectors that [solution_name] might download and one inspector it has internally.
5+
There are currently three inspectors that [solution_name] might download, and one internally coded inspector.
66

7-
If [solution_name] decides that your package manager needs an external inspector you must either be online or have the applicable air gap files.
7+
If [solution_name] decides that your package manager requires an external inspector you must either be online or have the applicable air gap files available.
88

99
## Gradle inspector
1010

11-
For Gradle a common integrations library is added as a dependency to a temporary Gradle script file that is executed by the [solution_name] Gradle detector.
11+
For Gradle, a common integrations library is added as a dependency to a temporary Gradle script file that is executed by the [solution_name] Gradle detector.
1212

13-
If you are online the Synopsys Artifactory instance is added as a Maven repository and the library is downloaded by Gradle.
14-
If you are offline the air gap library jar files are added as classpath file dependencies.
13+
If you are online, the Synopsys Artifactory instance is added as a Maven repository and the library is downloaded by Gradle.
14+
If you are offline, the air gap library jar files are added as classpath file dependencies.
1515

1616
In both cases, the [solution_name] Gradle detector executes the custom Gradle script mentioned above, which invokes a custom Gradle task.
1717

@@ -21,21 +21,21 @@ The source code for the library is located at [GitHub](https://github.com/blackd
2121

2222
The Docker Inspector is available as a Java jar file or shell script for Linux or Mac.
2323

24-
If you are online the Synopsys Artifactory instance is used to download the Docker Inspector jar file.
24+
If you are online, the Synopsys Artifactory instance is used to download the Docker Inspector jar file.
2525

26-
If you are offline the Docker Inspector jar file and required Docker image tar files are sourced from the provided path to the Docker Inspector air gap files.
26+
If you are offline, the Docker Inspector jar file and required Docker image tar files are sourced from the path provided to the Docker Inspector air gap files.
2727
[solution_name] loads the Docker images (container-based services that Docker Inspector depends on) from the provided image tar files so they are available to the Docker Inspector.
2828

2929
In either case the Docker Inspector jar is run by default which uses your Docker engine to start and stop the container-based services.
3030

31-
The source code for Docker Inspector is located at [GitHub](https://github.com/blackducksoftware/blackduck-docker-inspector).
31+
The source code for Docker Inspector is located at [GitHub](https://github.com/blackducksoftware/detect-docker-inspector).
3232

3333
## NuGet Inspector
3434

35-
The NuGet inspector is available as an independent executable for Windows, Linux and Mac.
35+
The NuGet inspector is available as an independent executable for Windows, Linux, and Mac.
3636

37-
If you are online the Synopsys Artifactory instance is used to download the applicable NuGet inspector which is then unzipped and the runtime files are located.
38-
If you are offline the air gap inspector runtime files are located at the provided path.
37+
If you are online, the Synopsys Artifactory instance is used to download the applicable NuGet inspector which is then unzipped and the runtime files are located.
38+
If you are offline, the air gap inspector runtime files are located at the provided path.
3939

4040
In either case the located executable is run which communicates with NuGet and the dotnet build system.
4141

documentation/src/main/markdown/currentreleasenotes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
* (IDETECT-4164) Improved Component Location Analysis parser support for package managers like Poetry that employ variable delimiters, for better location accuracy.
1212
* (IDETECT-4171) Improved Component Location Analysis data validation support for package managers like NPM.
1313
* (IDETECT-4174) Resolved an issue where [solution_name] was not sending the container scan size to [blackduck_product_name] server, resulting in [blackduck_product_name]'s "Scans" page reporting the size as zero.
14-
* (IDETECT-4176) The FULL_SNIPPET_MATCHING and FULL_SNIPPET_MATCHING_ONLY options, currently controlled via registration key, for the --detect.blackduck.signature.scanner.snippet.matching property will be deprecated in the next major release of [solution_name].
14+
* (IDETECT-4176) The FULL_SNIPPET_MATCHING and FULL_SNIPPET_MATCHING_ONLY options, currently controlled via registration key, for the --detect.blackduck.signature.scanner.snippet.matching property are deprecated and will be removed in the next major release of [solution_name].
1515

1616
### Dependency updates
1717

18-
* Updated Guava library from 31.1 to 32.1.2 to resolve high severity [CVE-2023-2976](https://nvd.nist.gov/vuln/detail/CVE-2023-2976).
18+
* Updated Guava library from 31.1 to 32.1.2 to resolve high severity [CVE-2023-2976](https://nvd.nist.gov/vuln/detail/CVE-2023-2976).

0 commit comments

Comments
 (0)