diff --git a/website/docs/configuration/how-to-fix-text-provider.md b/website/docs/configuration/how-to-fix-text-provider.md index 752f235350742..e7f2cc6a006b2 100644 --- a/website/docs/configuration/how-to-fix-text-provider.md +++ b/website/docs/configuration/how-to-fix-text-provider.md @@ -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 diff --git a/website/docs/configuration/reporter-templates.md b/website/docs/configuration/reporter-templates.md index 2c5156e15b923..407e07ef62ba0 100644 --- a/website/docs/configuration/reporter-templates.md +++ b/website/docs/configuration/reporter-templates.md @@ -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 @@ -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.