From 9f5f9f0da692094e5f4d570cdd55ab36bd7ab552 Mon Sep 17 00:00:00 2001 From: Martin Nonnenmacher Date: Fri, 15 Sep 2023 17:30:44 +0200 Subject: [PATCH] docs: Move the docs and toturial directories to the root Move the docs and tutorial directories from the docusaurus directory to the root of the repository to make them easier to discover when looking at the repository. Signed-off-by: Martin Nonnenmacher --- .reuse/dep5 | 10 +++++++++- {docusaurus/docs => docs}/configuration/_category_.yml | 0 .../docs => docs}/configuration/copyright-garbage.md | 0 .../docs => docs}/configuration/evaluator-rules.md | 0 .../configuration/how-to-fix-text-provider.md | 0 .../configuration/license-classifications.md | 0 .../docs => docs}/configuration/license-texts.md | 0 {docusaurus/docs => docs}/configuration/ort-yml.md | 0 .../configuration/package-configurations.md | 0 .../docs => docs}/configuration/package-curations.md | 0 .../docs => docs}/configuration/reporter-templates.md | 0 {docusaurus/docs => docs}/configuration/resolutions.md | 0 {docusaurus/docs => docs}/development.md | 0 .../docs => docs}/getting-started/_category_.yml | 0 .../docs => docs}/getting-started/installation.md | 0 .../getting-started/runtime-requirements.md | 0 {docusaurus/docs => docs}/getting-started/usage.md | 0 {docusaurus/docs => docs}/guides/_category_.yml | 0 {docusaurus/docs => docs}/guides/docker.md | 0 {docusaurus/docs => docs}/guides/license-handling.md | 0 {docusaurus/docs => docs}/guides/sw360-integration.md | 0 {docusaurus/docs => docs}/intro.md | 0 {docusaurus/docs => docs}/license.md | 0 {docusaurus/docs => docs}/related-tools.md | 0 {docusaurus/docs => docs}/tools/_category_.yml | 0 {docusaurus/docs => docs}/tools/advisor.md | 0 {docusaurus/docs => docs}/tools/analyzer.md | 0 {docusaurus/docs => docs}/tools/downloader.md | 0 {docusaurus/docs => docs}/tools/evaluator.md | 0 {docusaurus/docs => docs}/tools/reporter.md | 0 {docusaurus/docs => docs}/tools/scanner.md | 0 docusaurus/docusaurus.config.js | 7 ++++--- {docusaurus/tutorial => tutorial}/intro.md | 0 33 files changed, 13 insertions(+), 4 deletions(-) rename {docusaurus/docs => docs}/configuration/_category_.yml (100%) rename {docusaurus/docs => docs}/configuration/copyright-garbage.md (100%) rename {docusaurus/docs => docs}/configuration/evaluator-rules.md (100%) rename {docusaurus/docs => docs}/configuration/how-to-fix-text-provider.md (100%) rename {docusaurus/docs => docs}/configuration/license-classifications.md (100%) rename {docusaurus/docs => docs}/configuration/license-texts.md (100%) rename {docusaurus/docs => docs}/configuration/ort-yml.md (100%) rename {docusaurus/docs => docs}/configuration/package-configurations.md (100%) rename {docusaurus/docs => docs}/configuration/package-curations.md (100%) rename {docusaurus/docs => docs}/configuration/reporter-templates.md (100%) rename {docusaurus/docs => docs}/configuration/resolutions.md (100%) rename {docusaurus/docs => docs}/development.md (100%) rename {docusaurus/docs => docs}/getting-started/_category_.yml (100%) rename {docusaurus/docs => docs}/getting-started/installation.md (100%) rename {docusaurus/docs => docs}/getting-started/runtime-requirements.md (100%) rename {docusaurus/docs => docs}/getting-started/usage.md (100%) rename {docusaurus/docs => docs}/guides/_category_.yml (100%) rename {docusaurus/docs => docs}/guides/docker.md (100%) rename {docusaurus/docs => docs}/guides/license-handling.md (100%) rename {docusaurus/docs => docs}/guides/sw360-integration.md (100%) rename {docusaurus/docs => docs}/intro.md (100%) rename {docusaurus/docs => docs}/license.md (100%) rename {docusaurus/docs => docs}/related-tools.md (100%) rename {docusaurus/docs => docs}/tools/_category_.yml (100%) rename {docusaurus/docs => docs}/tools/advisor.md (100%) rename {docusaurus/docs => docs}/tools/analyzer.md (100%) rename {docusaurus/docs => docs}/tools/downloader.md (100%) rename {docusaurus/docs => docs}/tools/evaluator.md (100%) rename {docusaurus/docs => docs}/tools/reporter.md (100%) rename {docusaurus/docs => docs}/tools/scanner.md (100%) rename {docusaurus/tutorial => tutorial}/intro.md (100%) diff --git a/.reuse/dep5 b/.reuse/dep5 index b6cc016a5014b..d19432d300809 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -56,10 +56,14 @@ Files: clients/github-graphql/src/main/assets/* Copyright: 2021 The ORT Project Authors (see ) License: Apache-2.0 -Files: docusaurus/* +Files: docs/* Copyright: 2017 The ORT Project Authors (see ) License: Apache-2.0 +Files: docusaurus/* +Copyright: 2023 The ORT Project Authors (see ) +License: Apache-2.0 + Files: examples/* Copyright: 2017 The ORT Project Authors (see ) License: Apache-2.0 @@ -88,6 +92,10 @@ Files: plugins/reporters/web-app-template/* Copyright: 2017 The ORT Project Authors (see ) License: Apache-2.0 +Files: tutorial/* +Copyright: 2017 The ORT Project Authors (see ) +License: Apache-2.0 + # Third-party files. Files: batect* diff --git a/docusaurus/docs/configuration/_category_.yml b/docs/configuration/_category_.yml similarity index 100% rename from docusaurus/docs/configuration/_category_.yml rename to docs/configuration/_category_.yml diff --git a/docusaurus/docs/configuration/copyright-garbage.md b/docs/configuration/copyright-garbage.md similarity index 100% rename from docusaurus/docs/configuration/copyright-garbage.md rename to docs/configuration/copyright-garbage.md diff --git a/docusaurus/docs/configuration/evaluator-rules.md b/docs/configuration/evaluator-rules.md similarity index 100% rename from docusaurus/docs/configuration/evaluator-rules.md rename to docs/configuration/evaluator-rules.md diff --git a/docusaurus/docs/configuration/how-to-fix-text-provider.md b/docs/configuration/how-to-fix-text-provider.md similarity index 100% rename from docusaurus/docs/configuration/how-to-fix-text-provider.md rename to docs/configuration/how-to-fix-text-provider.md diff --git a/docusaurus/docs/configuration/license-classifications.md b/docs/configuration/license-classifications.md similarity index 100% rename from docusaurus/docs/configuration/license-classifications.md rename to docs/configuration/license-classifications.md diff --git a/docusaurus/docs/configuration/license-texts.md b/docs/configuration/license-texts.md similarity index 100% rename from docusaurus/docs/configuration/license-texts.md rename to docs/configuration/license-texts.md diff --git a/docusaurus/docs/configuration/ort-yml.md b/docs/configuration/ort-yml.md similarity index 100% rename from docusaurus/docs/configuration/ort-yml.md rename to docs/configuration/ort-yml.md diff --git a/docusaurus/docs/configuration/package-configurations.md b/docs/configuration/package-configurations.md similarity index 100% rename from docusaurus/docs/configuration/package-configurations.md rename to docs/configuration/package-configurations.md diff --git a/docusaurus/docs/configuration/package-curations.md b/docs/configuration/package-curations.md similarity index 100% rename from docusaurus/docs/configuration/package-curations.md rename to docs/configuration/package-curations.md diff --git a/docusaurus/docs/configuration/reporter-templates.md b/docs/configuration/reporter-templates.md similarity index 100% rename from docusaurus/docs/configuration/reporter-templates.md rename to docs/configuration/reporter-templates.md diff --git a/docusaurus/docs/configuration/resolutions.md b/docs/configuration/resolutions.md similarity index 100% rename from docusaurus/docs/configuration/resolutions.md rename to docs/configuration/resolutions.md diff --git a/docusaurus/docs/development.md b/docs/development.md similarity index 100% rename from docusaurus/docs/development.md rename to docs/development.md diff --git a/docusaurus/docs/getting-started/_category_.yml b/docs/getting-started/_category_.yml similarity index 100% rename from docusaurus/docs/getting-started/_category_.yml rename to docs/getting-started/_category_.yml diff --git a/docusaurus/docs/getting-started/installation.md b/docs/getting-started/installation.md similarity index 100% rename from docusaurus/docs/getting-started/installation.md rename to docs/getting-started/installation.md diff --git a/docusaurus/docs/getting-started/runtime-requirements.md b/docs/getting-started/runtime-requirements.md similarity index 100% rename from docusaurus/docs/getting-started/runtime-requirements.md rename to docs/getting-started/runtime-requirements.md diff --git a/docusaurus/docs/getting-started/usage.md b/docs/getting-started/usage.md similarity index 100% rename from docusaurus/docs/getting-started/usage.md rename to docs/getting-started/usage.md diff --git a/docusaurus/docs/guides/_category_.yml b/docs/guides/_category_.yml similarity index 100% rename from docusaurus/docs/guides/_category_.yml rename to docs/guides/_category_.yml diff --git a/docusaurus/docs/guides/docker.md b/docs/guides/docker.md similarity index 100% rename from docusaurus/docs/guides/docker.md rename to docs/guides/docker.md diff --git a/docusaurus/docs/guides/license-handling.md b/docs/guides/license-handling.md similarity index 100% rename from docusaurus/docs/guides/license-handling.md rename to docs/guides/license-handling.md diff --git a/docusaurus/docs/guides/sw360-integration.md b/docs/guides/sw360-integration.md similarity index 100% rename from docusaurus/docs/guides/sw360-integration.md rename to docs/guides/sw360-integration.md diff --git a/docusaurus/docs/intro.md b/docs/intro.md similarity index 100% rename from docusaurus/docs/intro.md rename to docs/intro.md diff --git a/docusaurus/docs/license.md b/docs/license.md similarity index 100% rename from docusaurus/docs/license.md rename to docs/license.md diff --git a/docusaurus/docs/related-tools.md b/docs/related-tools.md similarity index 100% rename from docusaurus/docs/related-tools.md rename to docs/related-tools.md diff --git a/docusaurus/docs/tools/_category_.yml b/docs/tools/_category_.yml similarity index 100% rename from docusaurus/docs/tools/_category_.yml rename to docs/tools/_category_.yml diff --git a/docusaurus/docs/tools/advisor.md b/docs/tools/advisor.md similarity index 100% rename from docusaurus/docs/tools/advisor.md rename to docs/tools/advisor.md diff --git a/docusaurus/docs/tools/analyzer.md b/docs/tools/analyzer.md similarity index 100% rename from docusaurus/docs/tools/analyzer.md rename to docs/tools/analyzer.md diff --git a/docusaurus/docs/tools/downloader.md b/docs/tools/downloader.md similarity index 100% rename from docusaurus/docs/tools/downloader.md rename to docs/tools/downloader.md diff --git a/docusaurus/docs/tools/evaluator.md b/docs/tools/evaluator.md similarity index 100% rename from docusaurus/docs/tools/evaluator.md rename to docs/tools/evaluator.md diff --git a/docusaurus/docs/tools/reporter.md b/docs/tools/reporter.md similarity index 100% rename from docusaurus/docs/tools/reporter.md rename to docs/tools/reporter.md diff --git a/docusaurus/docs/tools/scanner.md b/docs/tools/scanner.md similarity index 100% rename from docusaurus/docs/tools/scanner.md rename to docs/tools/scanner.md diff --git a/docusaurus/docusaurus.config.js b/docusaurus/docusaurus.config.js index e30605ab23654..3c2141071037c 100644 --- a/docusaurus/docusaurus.config.js +++ b/docusaurus/docusaurus.config.js @@ -39,12 +39,13 @@ const config = { /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { + path: '../docs', routeBasePath: '/docs/', sidebarPath: require.resolve('./sidebars.js'), // Please change this to your repo. // Remove this to remove the "edit this page" links. editUrl: - 'https://github.com/oss-review-toolkit/ort/tree/main/docusaurus/', + 'https://github.com/oss-review-toolkit/ort/tree/main/', }, blog: false, theme: { @@ -60,11 +61,11 @@ const config = { /** @type {import('@docusaurus/plugin-content-docs').Options} */ ({ id: 'tutorial', - path: 'tutorial', + path: '../tutorial', routeBasePath: '/tutorial/', sidebarPath: require.resolve('./sidebars.js'), editUrl: - 'https://github.com/oss-review-toolkit/ort/tree/main/docusaurus/', + 'https://github.com/oss-review-toolkit/ort/tree/main/', }), ] ], diff --git a/docusaurus/tutorial/intro.md b/tutorial/intro.md similarity index 100% rename from docusaurus/tutorial/intro.md rename to tutorial/intro.md