Skip to content

Commit

Permalink
docs(website): Fix-up several broken links
Browse files Browse the repository at this point in the history
Signed-off-by: Frank Viernau <[email protected]>
  • Loading branch information
fviernau committed Oct 6, 2023
1 parent b6e122f commit c0ad448
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion website/docs/configuration/how-to-fix-text-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The `reporter.how-to-fix-text-provider.kts` file enables the injection of how-to-fix texts in Markdown format for ORT
issues into the reports.

You can use the [example how-to-fix-text-provider](../../examples/example.how-to-fix-text-provider.kts) as the base
You can use the [example how-to-fix-text-provider](../../../examples/example.how-to-fix-text-provider.kts) as the base
script file to create your custom how-to-fix messages in the generated reports.

## Command Line
Expand Down
12 changes: 6 additions & 6 deletions website/docs/configuration/reporter-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ intermediate file is created that can be processed by AsciidoctorJ. If no option
### General report options

* `template.id`: A comma-separated list of IDs for templates built into ORT. Currently, the following IDs are supported:
* "[disclosure_document](../../plugins/reporters/asciidoc/src/main/resources/templates/asciidoc/disclosure_document.ftl)"
* "[vulnerability_report](../../plugins/reporters/asciidoc/src/main/resources/templates/asciidoc/vulnerability_report.ftl)"
* "[defect_report](../../plugins/reporters/asciidoc/src/main/resources/templates/asciidoc/defect_report.ftl)"
* "[disclosure_document](../../../plugins/reporters/asciidoc/src/main/resources/templates/asciidoc/disclosure_document.ftl)"
* "[vulnerability_report](../../../plugins/reporters/asciidoc/src/main/resources/templates/asciidoc/vulnerability_report.ftl)"
* "[defect_report](../../../plugins/reporters/asciidoc/src/main/resources/templates/asciidoc/defect_report.ftl)"
* `template.path`: A comma-separated list of paths to template files provided by the user.

### Supported formats
Expand Down Expand Up @@ -98,15 +98,15 @@ import Example from '!!raw-loader!@site/../examples/asciidoctor-pdf-theme.yml'

## Plain Text Templates

The [`PlainTextTemplateReporter`](../../plugins/reporters/freemarker/src/main/kotlin/PlainTextTemplateReporter.kt)
The [`PlainTextTemplateReporter`](../../../plugins/reporters/freemarker/src/main/kotlin/PlainTextTemplateReporter.kt)
enables customization of the generated open source notices with [Apache Freemarker](https://freemarker.apache.org/)
templates and producing any other arbitrary plain text files, such as `.adoc` files.

ORT provides two templates that can be used as a base for creating your custom open source notices:

* [default](../../plugins/reporters/freemarker/src/main/resources/templates/plain-text/NOTICE_DEFAULT.ftl): Prints a
* [default](../../../plugins/reporters/freemarker/src/main/resources/templates/plain-text/NOTICE_DEFAULT.ftl): Prints a
summary of all licenses found in the project itself and lists licenses for all dependencies separately.
* [summary](../../plugins/reporters/freemarker/src/main/resources/templates/plain-text/NOTICE_SUMMARY.ftl): Prints a
* [summary](../../../plugins/reporters/freemarker/src/main/resources/templates/plain-text/NOTICE_SUMMARY.ftl): Prints a
summary of all licenses found in the project itself and all dependencies.

See the code comments in the templates for how they work.
Expand Down

0 comments on commit c0ad448

Please sign in to comment.