Skip to content

Commit 244d421

Browse files
tsteenbemaennchen
andcommitted
docs: Reorg and improve user experience
Reorganize and improve documentation to provide a better getting started and documentation navigation user experience. This pull requests includes: - Adoption of the Diátaxis framework which prioritizes user needs and organizes documentation accordingly. This approach ensures users can easily find the information they need while providing authors with clear guidance on improving documentation for a better user experience. - A new tutorial on how to use ORT - Several how-to guides have been added explaining how to accomplish specific tasks with ORT - Introduces a new explanation section to provide background and context e.g. the 'why' things are so (design decisions, historical reasons, technical constraints) Co-authored-by: Jonatan Männchen <jonatan@maennchen.ch> Signed-off-by: Jonatan Männchen <jonatan@maennchen.ch> Signed-off-by: Thomas Steenbergen <opensource@steenbe.nl>
1 parent 3dd5330 commit 244d421

File tree

98 files changed

+6028
-2037
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+6028
-2037
lines changed

buildSrc/src/main/kotlin/GeneratePluginDocsTask.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ abstract class GeneratePluginDocsTask : DefaultTask() {
3737
abstract var inputFiles: FileTree
3838

3939
@OutputDirectory
40-
val outputDirectory = project.layout.projectDirectory.file("website/docs/plugins").asFile
40+
val outputDirectory = project.layout.projectDirectory.file("website/docs/reference/plugins").asFile
4141

4242
@Internal
4343
val jsonSlurper = JsonSlurper()
Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1-
---
2-
sidebar_position: 8
3-
sidebar_label: Related Tools
4-
---
5-
61
# Related Tools
72

8-
## ORT Config Repository
3+
## Forgejo action for ORT
4+
5+
A [Forgejo Action](https://github.com/oss-review-toolkit/ort-ci-github-action) to run ORT.
6+
7+
## GitHub action for ORT
8+
9+
A [GitHub Action](https://github.com/oss-review-toolkit/ort-ci-github-action) to run ORT.
10+
11+
## GitLab job template for ORT
12+
13+
A [GitLab job template](https://github.com/oss-review-toolkit/ort-ci-gitlab) to run ORT.
14+
15+
## ORT config repository
916

1017
A [repository](https://github.com/oss-review-toolkit/ort-config) with exemplary ORT configuration files.
1118

@@ -17,18 +24,10 @@ It is designed to run inside a Kubernetes cluster and can be used via a REST API
1724
## ORT Workbench
1825

1926
The [ORT Workbench](https://github.com/oss-review-toolkit/ort-workbench) is an ORT result file viewer developed by the ORT core team.
20-
It can be used as an alternative to creating a [report](tools/reporter.md) to review the ORT output.
27+
It can be used as an alternative to creating a [report](reference/cli/reporter.md) to review the ORT output.
2128

2229
![Screenshot](https://github.com/oss-review-toolkit/ort-workbench/raw/main/assets/screenshot.png)
2330

24-
## ORT GitHub Action
25-
26-
A [GitHub Action](https://github.com/oss-review-toolkit/ort-ci-github-action) to run ORT for your GitHub repositories.
27-
28-
## ORT GitLab Pipeline
29-
30-
A [GitLab Pipeline](https://github.com/oss-review-toolkit/ort-gitlab-ci) to run ORT for your GitLab repositories.
31-
3231
## ORTHW
3332

3433
A [bash script](https://github.com/oss-review-toolkit/orthw) that helps to simplify and speed up common tasks performed when processing ORT results.

website/docs/configuration/_category_.yml

Lines changed: 0 additions & 6 deletions
This file was deleted.

website/docs/configuration/copyright-garbage.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

website/docs/configuration/evaluator-rules.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

website/docs/configuration/how-to-fix-text-provider.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

website/docs/configuration/license-classifications.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

0 commit comments

Comments
 (0)