Skip to content

Commit

Permalink
style(help): help develment
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Billings committed Nov 19, 2019
1 parent dedf341 commit 00ea941
Show file tree
Hide file tree
Showing 4 changed files with 305 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/templates/content/3-blackduck.ftl
Expand Up @@ -16,6 +16,7 @@ ${solution_name} can be configured to perform additional tasks, including the fo
* Run the ${blackduck_product_name} [binary scanner](/properties/Configuration/signature%20scanner) on a given binary files.
* Run the ${dockerinspector_name} on a given [Docker image](/advanced/language-and-package-managers/docker-images).
* Generate a [report](http://localhost:8000/properties/Configuration/report/).
* Fail on [policy violation](/properties/Configuration/project/#fail-on-policy-violation-severities).

See [${blackduck_product_name} Server properties](/properties/Configuration/blackduck%20server)
and [Signature Scanner properties](/properties/Configuration/signature%20scanner/) for details.
Expand Down
@@ -0,0 +1,8 @@
# Yarn support

${solution_name} will run the Yarn detector if it finds both of the following in your project:

* yarn.lock
* package.json

The Yarn detector reads both files and derives dependency information from their contents.
24 changes: 24 additions & 0 deletions docs/templates/content/advanced/naming.ftl
@@ -0,0 +1,24 @@
# Naming

## Project and version naming

By default, ${solution_name} attempts to derive the name and version of your project using the same methods that the detector
uses to derive dependency information. For example, in a Maven project, the Maven detector will derive the project name
and version from Maven. For projects managed using Git, if ${solution_name} is unable to determine the project name/version
from the package manager, it may be able to determine the project name
and version (branch) from Git.

You can override the project [name](/properties/Configuration/project/#project-name) and/or [version](/properties/Configuration/project/#version-name)
using properties.

## Code location (scan) naming

By default, a code location (scan) name generated by a detector is constructed from information that it derives
from the package manager, such as project name and version, sub-project or module if applicable,
and the detector type. Code location names generated by detectors end in `bom`.

A code location name generated by the signature scanner is constructed from the source directory name,
project name, and project version. Code location names generated by the signature scanner end in `scan`.

Optionally, you can add a [prefix](/properties/Configuration/project/#scan-name-prefix-advanced) to the automatically
generated code location names, or provided a base [name](/properties/Configuration/project/#scan-name-advanced).

0 comments on commit 00ea941

Please sign in to comment.