Skip to content

Commit

Permalink
docs(README): Update links
Browse files Browse the repository at this point in the history
Signed-off-by: Nicolas Nobelis <[email protected]>
  • Loading branch information
nnobelis authored and sschuberth committed Oct 15, 2023
1 parent ff77e61 commit 39c0534
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ To print the active configuration use:
ort config --show-active
```

#### [Copyright garbage file](./docs/config-file-copyright-garbage-yml.md)
#### [Copyright garbage file](./website/docs/configuration/copyright-garbage.md)

A list of copyright statements that are considered garbage, for example statements that were incorrectly classified as
copyrights by the scanner.
Expand All @@ -246,39 +246,39 @@ copyrights by the scanner.
|-------------|--------|-----------------------------------------|
| YAML / JSON | Global | `$ORT_CONFIG_DIR/copyright-garbage.yml` |

#### [Curations file](./docs/config-file-curations-yml.md)
#### [Curations file](./website/docs/configuration/package-curations.md)

A file to correct invalid or missing package metadata, and to set the concluded license for packages.

| Format | Scope | Default location |
|-------------|--------|---------------------------------|
| YAML / JSON | Global | `$ORT_CONFIG_DIR/curations.yml` |

#### [Custom license texts dir](./docs/dir-custom-license-texts.md)
#### [Custom license texts dir](./website/docs/configuration/license-texts.md)

A directory that contains license texts which are not provided by ORT.

| Format | Scope | Default location |
|--------|--------|-----------------------------------------|
| Text | Global | `$ORT_CONFIG_DIR/custom-license-texts/` |

#### [How to fix text provider script](./docs/scripts/how-to-fix-text-provider-kts.md)
#### [How to fix text provider script](./website/docs/configuration/how-to-fix-text-provider.md)

A Kotlin script that enables the injection of how-to-fix texts in Markdown format for ORT issues into the reports.

| Format | Scope | Default location |
|---------------|--------|---------------------------------------------------------|
| Kotlin script | Global | `$ORT_CONFIG_DIR/reporter.how-to-fix-text-provider.kts` |

#### [License classifications file](docs/config-file-license-classifications-yml.md)
#### [License classifications file](./website/docs/configuration/license-classifications.md)

A file that contains user-defined categorization of licenses.

| Format | Scope | Default location |
|-------------|--------|-----------------------------------------------|
| YAML / JSON | Global | `$ORT_CONFIG_DIR/license-classifications.yml` |

#### [Resolution file](./docs/config-file-resolutions-yml.md)
#### [Resolution file](./website/docs/configuration/resolutions.md)

Configurations to resolve any issues or rule violations by providing a mandatory reason, and an optional comment to
justify the resolution on a global scale.
Expand All @@ -287,7 +287,7 @@ justify the resolution on a global scale.
|-------------|--------|-----------------------------------|
| YAML / JSON | Global | `$ORT_CONFIG_DIR/resolutions.yml` |

#### [Repository configuration file](./docs/config-file-ort-yml.md)
#### [Repository configuration file](./website/docs/configuration/ort-yml.md)

A configuration file, usually stored in the project's repository, for license finding curations, exclusions, and issues
or rule violations resolutions in the context of the repository.
Expand All @@ -296,7 +296,7 @@ or rule violations resolutions in the context of the repository.
|-------------|----------------------|---------------------------------|
| YAML / JSON | Repository (project) | `[analyzer-input-dir]/.ort.yml` |

#### [Package configuration file / directory](./docs/config-file-package-configuration-yml.md)
#### [Package configuration file / directory](./website/docs/configuration/package-configurations.md)

A single file or a directory with multiple files containing configurations to set provenance-specific path excludes and
license finding curations for dependency packages to address issues found within a scan result. `helper-cli`'s
Expand All @@ -307,7 +307,7 @@ can be used to populate a directory with template package configuration files.
|-------------|----------------------|-------------------------------------------|
| YAML / JSON | Package (dependency) | `$ORT_CONFIG_DIR/package-configurations/` |

#### [Policy rules file](./docs/scripts/rules-kts.md)
#### [Policy rules file](./website/docs/configuration/evaluator-rules.md)

The file containing any policy rule implementations to be used with the *evaluator*.

Expand Down

0 comments on commit 39c0534

Please sign in to comment.