Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cp-idetect-4646 #1380

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions documentation/src/main/markdown/components/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Each [detect_product_short] run consists of running any applicable [detect_produ

[detect_product_short] uses [detectors](detectors.md), appropriate to your package manager ecosystem, to find and extract dependencies from all supported package managers.

For a quick tutorial on detectors, see: [Detectors Introduction](https://community.blackduck.com/s/article/Black-Duck-Detectors-Introduction).

## Inspectors

An [inspector](inspectors.md) is typically a plugin that [detect_product_short] uses to access the internal resources of a package manager through its API.

5 changes: 2 additions & 3 deletions documentation/src/main/markdown/gettingstarted/configuring.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Configuration Overview

What [detect_product_long] looks at and how it performs its analysis depends on how you configure [detect_product_short].
What [detect_product_long] looks at and how it performs analysis depends on how it is configured.

> For accurate SCA analysis, [detect_product_short] should be executed as a post-build step typically in the native build environment.
<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>

Using properties, you can configure the following:

Expand All @@ -13,4 +13,3 @@ Using properties, you can configure the following:
* Sensitivity to policy violations
* Reporting
* Logging

2 changes: 2 additions & 0 deletions documentation/src/main/markdown/gettingstarted/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@

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].

For a quick tutorial see: [Introduction to Scanning](https://community.blackduck.com/s/article/Black-Duck-Introduction-to-Scanning).

<note type="note">[detect_product_short] documentation is incremental in nature with new functionality and changes indentified in the [Release notes](../currentreleasenotes.md) and [Properties](../properties/all-properties.md). However, documentation is also available for previous [detect_product_short] versions by navigating to the documentation portal [linked here](https://documentation.blackduck.com/bundle) and clicking on the **Archived** button.</note>

Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ Before you download and run [detect_product_short], you should make the followin
- What [tools and detectors](../../components/overview.md) do you want to include or exclude?
- Do you want to run [detect_product_short] offline, or connected to [bd_product_short]?
- Would you like to share scan settings and run autonomous [detect_product_short] scans?

For a quick introduction to configuring scans, see: [Scanning Best Practices Interactive Tutorial](https://community.blackduck.com/s/article/Black-Duck-Scanning-Best-Practices-Interactive-Tutorial).