From 14cc5f1212895f91202248badacf0e4de9ed8127 Mon Sep 17 00:00:00 2001 From: Martin Nonnenmacher Date: Thu, 21 Sep 2023 12:22:49 +0200 Subject: [PATCH] docs: Rename the `docusaurus` directory to `website` Rename the directory so that it is named after the purpose instead of after the used tool. Signed-off-by: Martin Nonnenmacher --- .../{docusaurus-deploy.yml => website-deploy.yml} | 14 +++++++------- .../{docusaurus-test.yml => website-test.yml} | 10 +++++----- .reuse/dep5 | 8 ++++---- buildSrc/src/main/kotlin/LicenseUtils.kt | 14 +++++++------- {docusaurus => website}/.gitignore | 0 {docusaurus => website}/README.md | 0 {docusaurus => website}/babel.config.js | 0 .../docs/configuration/_category_.yml | 0 .../docs/configuration/copyright-garbage.md | 0 .../docs/configuration/evaluator-rules.md | 0 .../configuration/how-to-fix-text-provider.md | 0 .../docs/configuration/license-classifications.md | 0 .../docs/configuration/license-texts.md | 0 .../docs/configuration/ort-yml.md | 0 .../docs/configuration/package-configurations.md | 0 .../docs/configuration/package-curations.md | 0 .../docs/configuration/reporter-templates.md | 0 .../docs/configuration/resolutions.md | 0 {docusaurus => website}/docs/development.md | 0 .../docs/getting-started/_category_.yml | 0 .../docs/getting-started/installation.md | 0 .../docs/getting-started/runtime-requirements.md | 0 .../docs/getting-started/usage.md | 0 .../docs/guides/_category_.yml | 0 {docusaurus => website}/docs/guides/docker.md | 0 .../docs/guides/license-handling.md | 0 .../docs/guides/sw360-integration.md | 0 {docusaurus => website}/docs/intro.md | 0 {docusaurus => website}/docs/license.md | 0 {docusaurus => website}/docs/related-tools.md | 0 {docusaurus => website}/docs/tools/_category_.yml | 0 {docusaurus => website}/docs/tools/advisor.md | 0 {docusaurus => website}/docs/tools/analyzer.md | 0 {docusaurus => website}/docs/tools/downloader.md | 0 {docusaurus => website}/docs/tools/evaluator.md | 0 {docusaurus => website}/docs/tools/reporter.md | 0 {docusaurus => website}/docs/tools/scanner.md | 0 {docusaurus => website}/docusaurus.config.js | 0 {docusaurus => website}/package-lock.json | 0 {docusaurus => website}/package.json | 0 {docusaurus => website}/sidebars.js | 0 .../src/components/HomepageFeatures/index.js | 0 .../components/HomepageFeatures/styles.module.css | 0 {docusaurus => website}/src/css/custom.css | 0 {docusaurus => website}/src/pages/index.js | 0 .../src/pages/index.module.css | 0 {docusaurus => website}/static/.nojekyll | 0 {docusaurus => website}/static/img/advisor.svg | 0 {docusaurus => website}/static/img/analyzer.svg | 0 {docusaurus => website}/static/img/docusaurus.png | Bin {docusaurus => website}/static/img/downloader.svg | 0 {docusaurus => website}/static/img/evaluator.svg | 0 {docusaurus => website}/static/img/favicon.ico | Bin {docusaurus => website}/static/img/logo.svg | 0 {docusaurus => website}/static/img/ort.png | Bin {docusaurus => website}/static/img/reporter.svg | 0 {docusaurus => website}/static/img/scanner.svg | 0 {docusaurus => website}/tutorial/intro.md | 0 58 files changed, 23 insertions(+), 23 deletions(-) rename .github/workflows/{docusaurus-deploy.yml => website-deploy.yml} (72%) rename .github/workflows/{docusaurus-test.yml => website-test.yml} (64%) rename {docusaurus => website}/.gitignore (100%) rename {docusaurus => website}/README.md (100%) rename {docusaurus => website}/babel.config.js (100%) rename {docusaurus => website}/docs/configuration/_category_.yml (100%) rename {docusaurus => website}/docs/configuration/copyright-garbage.md (100%) rename {docusaurus => website}/docs/configuration/evaluator-rules.md (100%) rename {docusaurus => website}/docs/configuration/how-to-fix-text-provider.md (100%) rename {docusaurus => website}/docs/configuration/license-classifications.md (100%) rename {docusaurus => website}/docs/configuration/license-texts.md (100%) rename {docusaurus => website}/docs/configuration/ort-yml.md (100%) rename {docusaurus => website}/docs/configuration/package-configurations.md (100%) rename {docusaurus => website}/docs/configuration/package-curations.md (100%) rename {docusaurus => website}/docs/configuration/reporter-templates.md (100%) rename {docusaurus => website}/docs/configuration/resolutions.md (100%) rename {docusaurus => website}/docs/development.md (100%) rename {docusaurus => website}/docs/getting-started/_category_.yml (100%) rename {docusaurus => website}/docs/getting-started/installation.md (100%) rename {docusaurus => website}/docs/getting-started/runtime-requirements.md (100%) rename {docusaurus => website}/docs/getting-started/usage.md (100%) rename {docusaurus => website}/docs/guides/_category_.yml (100%) rename {docusaurus => website}/docs/guides/docker.md (100%) rename {docusaurus => website}/docs/guides/license-handling.md (100%) rename {docusaurus => website}/docs/guides/sw360-integration.md (100%) rename {docusaurus => website}/docs/intro.md (100%) rename {docusaurus => website}/docs/license.md (100%) rename {docusaurus => website}/docs/related-tools.md (100%) rename {docusaurus => website}/docs/tools/_category_.yml (100%) rename {docusaurus => website}/docs/tools/advisor.md (100%) rename {docusaurus => website}/docs/tools/analyzer.md (100%) rename {docusaurus => website}/docs/tools/downloader.md (100%) rename {docusaurus => website}/docs/tools/evaluator.md (100%) rename {docusaurus => website}/docs/tools/reporter.md (100%) rename {docusaurus => website}/docs/tools/scanner.md (100%) rename {docusaurus => website}/docusaurus.config.js (100%) rename {docusaurus => website}/package-lock.json (100%) rename {docusaurus => website}/package.json (100%) rename {docusaurus => website}/sidebars.js (100%) rename {docusaurus => website}/src/components/HomepageFeatures/index.js (100%) rename {docusaurus => website}/src/components/HomepageFeatures/styles.module.css (100%) rename {docusaurus => website}/src/css/custom.css (100%) rename {docusaurus => website}/src/pages/index.js (100%) rename {docusaurus => website}/src/pages/index.module.css (100%) rename {docusaurus => website}/static/.nojekyll (100%) rename {docusaurus => website}/static/img/advisor.svg (100%) rename {docusaurus => website}/static/img/analyzer.svg (100%) rename {docusaurus => website}/static/img/docusaurus.png (100%) rename {docusaurus => website}/static/img/downloader.svg (100%) rename {docusaurus => website}/static/img/evaluator.svg (100%) rename {docusaurus => website}/static/img/favicon.ico (100%) rename {docusaurus => website}/static/img/logo.svg (100%) rename {docusaurus => website}/static/img/ort.png (100%) rename {docusaurus => website}/static/img/reporter.svg (100%) rename {docusaurus => website}/static/img/scanner.svg (100%) rename {docusaurus => website}/tutorial/intro.md (100%) diff --git a/.github/workflows/docusaurus-deploy.yml b/.github/workflows/website-deploy.yml similarity index 72% rename from .github/workflows/docusaurus-deploy.yml rename to .github/workflows/website-deploy.yml index 2287c74b27a67..556225f6ac3c5 100644 --- a/.github/workflows/docusaurus-deploy.yml +++ b/.github/workflows/website-deploy.yml @@ -1,4 +1,4 @@ -name: Docusaurus Deploy +name: Website Deploy on: push: @@ -7,7 +7,7 @@ on: jobs: build: - name: Docusaurus Build + name: Website Build runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -15,18 +15,18 @@ jobs: with: node-version: 18 cache: npm - cache-dependency-path: docusaurus/package-lock.json + cache-dependency-path: website/package-lock.json - name: Install dependencies run: npm ci - working-directory: docusaurus + working-directory: website - name: Build website run: npm run build - working-directory: docusaurus + working-directory: website - uses: actions/upload-pages-artifact@v2 with: - path: docusaurus/build + path: website/build deploy: - name: Docusaurus Deploy + name: Website Deploy needs: build permissions: pages: write diff --git a/.github/workflows/docusaurus-test.yml b/.github/workflows/website-test.yml similarity index 64% rename from .github/workflows/docusaurus-test.yml rename to .github/workflows/website-test.yml index ec0ddfccd653b..5baec0990771b 100644 --- a/.github/workflows/docusaurus-test.yml +++ b/.github/workflows/website-test.yml @@ -1,4 +1,4 @@ -name: Docusaurus Test +name: Website Test on: pull_request: @@ -7,7 +7,7 @@ on: jobs: test: - name: Docusaurus Test + name: Website Test runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -15,10 +15,10 @@ jobs: with: node-version: 18 cache: npm - cache-dependency-path: docusaurus/package-lock.json + cache-dependency-path: website/package-lock.json - name: Install dependencies run: npm ci - working-directory: docusaurus + working-directory: website - name: Test build run: npm run build - working-directory: docusaurus + working-directory: website diff --git a/.reuse/dep5 b/.reuse/dep5 index b6cc016a5014b..ca7539bd84e82 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -56,10 +56,6 @@ Files: clients/github-graphql/src/main/assets/* Copyright: 2021 The ORT Project Authors (see ) License: Apache-2.0 -Files: docusaurus/* -Copyright: 2017 The ORT Project Authors (see ) -License: Apache-2.0 - Files: examples/* Copyright: 2017 The ORT Project Authors (see ) License: Apache-2.0 @@ -88,6 +84,10 @@ Files: plugins/reporters/web-app-template/* Copyright: 2017 The ORT Project Authors (see ) License: Apache-2.0 +Files: website/* +Copyright: 2017 The ORT Project Authors (see ) +License: Apache-2.0 + # Third-party files. Files: batect* diff --git a/buildSrc/src/main/kotlin/LicenseUtils.kt b/buildSrc/src/main/kotlin/LicenseUtils.kt index 0b6a1a87e7ca3..c98f1eee88d16 100644 --- a/buildSrc/src/main/kotlin/LicenseUtils.kt +++ b/buildSrc/src/main/kotlin/LicenseUtils.kt @@ -26,13 +26,13 @@ object CopyrightableFiles { "LICENSE", "NOTICE", "batect", - "docusaurus/babel.config.js", - "docusaurus/docusaurus.config.js", - "docusaurus/docs/configuration/_category_.yml", - "docusaurus/docs/getting-started/_category_.yml", - "docusaurus/docs/guides/_category_.yml", - "docusaurus/docs/tools/_category_.yml", - "docusaurus/sidebars.js", + "website/babel.config.js", + "website/docusaurus.config.js", + "website/docs/configuration/_category_.yml", + "website/docs/getting-started/_category_.yml", + "website/docs/guides/_category_.yml", + "website/docs/tools/_category_.yml", + "website/sidebars.js", "gradlew", "gradle/", "examples/", diff --git a/docusaurus/.gitignore b/website/.gitignore similarity index 100% rename from docusaurus/.gitignore rename to website/.gitignore diff --git a/docusaurus/README.md b/website/README.md similarity index 100% rename from docusaurus/README.md rename to website/README.md diff --git a/docusaurus/babel.config.js b/website/babel.config.js similarity index 100% rename from docusaurus/babel.config.js rename to website/babel.config.js diff --git a/docusaurus/docs/configuration/_category_.yml b/website/docs/configuration/_category_.yml similarity index 100% rename from docusaurus/docs/configuration/_category_.yml rename to website/docs/configuration/_category_.yml diff --git a/docusaurus/docs/configuration/copyright-garbage.md b/website/docs/configuration/copyright-garbage.md similarity index 100% rename from docusaurus/docs/configuration/copyright-garbage.md rename to website/docs/configuration/copyright-garbage.md diff --git a/docusaurus/docs/configuration/evaluator-rules.md b/website/docs/configuration/evaluator-rules.md similarity index 100% rename from docusaurus/docs/configuration/evaluator-rules.md rename to website/docs/configuration/evaluator-rules.md diff --git a/docusaurus/docs/configuration/how-to-fix-text-provider.md b/website/docs/configuration/how-to-fix-text-provider.md similarity index 100% rename from docusaurus/docs/configuration/how-to-fix-text-provider.md rename to website/docs/configuration/how-to-fix-text-provider.md diff --git a/docusaurus/docs/configuration/license-classifications.md b/website/docs/configuration/license-classifications.md similarity index 100% rename from docusaurus/docs/configuration/license-classifications.md rename to website/docs/configuration/license-classifications.md diff --git a/docusaurus/docs/configuration/license-texts.md b/website/docs/configuration/license-texts.md similarity index 100% rename from docusaurus/docs/configuration/license-texts.md rename to website/docs/configuration/license-texts.md diff --git a/docusaurus/docs/configuration/ort-yml.md b/website/docs/configuration/ort-yml.md similarity index 100% rename from docusaurus/docs/configuration/ort-yml.md rename to website/docs/configuration/ort-yml.md diff --git a/docusaurus/docs/configuration/package-configurations.md b/website/docs/configuration/package-configurations.md similarity index 100% rename from docusaurus/docs/configuration/package-configurations.md rename to website/docs/configuration/package-configurations.md diff --git a/docusaurus/docs/configuration/package-curations.md b/website/docs/configuration/package-curations.md similarity index 100% rename from docusaurus/docs/configuration/package-curations.md rename to website/docs/configuration/package-curations.md diff --git a/docusaurus/docs/configuration/reporter-templates.md b/website/docs/configuration/reporter-templates.md similarity index 100% rename from docusaurus/docs/configuration/reporter-templates.md rename to website/docs/configuration/reporter-templates.md diff --git a/docusaurus/docs/configuration/resolutions.md b/website/docs/configuration/resolutions.md similarity index 100% rename from docusaurus/docs/configuration/resolutions.md rename to website/docs/configuration/resolutions.md diff --git a/docusaurus/docs/development.md b/website/docs/development.md similarity index 100% rename from docusaurus/docs/development.md rename to website/docs/development.md diff --git a/docusaurus/docs/getting-started/_category_.yml b/website/docs/getting-started/_category_.yml similarity index 100% rename from docusaurus/docs/getting-started/_category_.yml rename to website/docs/getting-started/_category_.yml diff --git a/docusaurus/docs/getting-started/installation.md b/website/docs/getting-started/installation.md similarity index 100% rename from docusaurus/docs/getting-started/installation.md rename to website/docs/getting-started/installation.md diff --git a/docusaurus/docs/getting-started/runtime-requirements.md b/website/docs/getting-started/runtime-requirements.md similarity index 100% rename from docusaurus/docs/getting-started/runtime-requirements.md rename to website/docs/getting-started/runtime-requirements.md diff --git a/docusaurus/docs/getting-started/usage.md b/website/docs/getting-started/usage.md similarity index 100% rename from docusaurus/docs/getting-started/usage.md rename to website/docs/getting-started/usage.md diff --git a/docusaurus/docs/guides/_category_.yml b/website/docs/guides/_category_.yml similarity index 100% rename from docusaurus/docs/guides/_category_.yml rename to website/docs/guides/_category_.yml diff --git a/docusaurus/docs/guides/docker.md b/website/docs/guides/docker.md similarity index 100% rename from docusaurus/docs/guides/docker.md rename to website/docs/guides/docker.md diff --git a/docusaurus/docs/guides/license-handling.md b/website/docs/guides/license-handling.md similarity index 100% rename from docusaurus/docs/guides/license-handling.md rename to website/docs/guides/license-handling.md diff --git a/docusaurus/docs/guides/sw360-integration.md b/website/docs/guides/sw360-integration.md similarity index 100% rename from docusaurus/docs/guides/sw360-integration.md rename to website/docs/guides/sw360-integration.md diff --git a/docusaurus/docs/intro.md b/website/docs/intro.md similarity index 100% rename from docusaurus/docs/intro.md rename to website/docs/intro.md diff --git a/docusaurus/docs/license.md b/website/docs/license.md similarity index 100% rename from docusaurus/docs/license.md rename to website/docs/license.md diff --git a/docusaurus/docs/related-tools.md b/website/docs/related-tools.md similarity index 100% rename from docusaurus/docs/related-tools.md rename to website/docs/related-tools.md diff --git a/docusaurus/docs/tools/_category_.yml b/website/docs/tools/_category_.yml similarity index 100% rename from docusaurus/docs/tools/_category_.yml rename to website/docs/tools/_category_.yml diff --git a/docusaurus/docs/tools/advisor.md b/website/docs/tools/advisor.md similarity index 100% rename from docusaurus/docs/tools/advisor.md rename to website/docs/tools/advisor.md diff --git a/docusaurus/docs/tools/analyzer.md b/website/docs/tools/analyzer.md similarity index 100% rename from docusaurus/docs/tools/analyzer.md rename to website/docs/tools/analyzer.md diff --git a/docusaurus/docs/tools/downloader.md b/website/docs/tools/downloader.md similarity index 100% rename from docusaurus/docs/tools/downloader.md rename to website/docs/tools/downloader.md diff --git a/docusaurus/docs/tools/evaluator.md b/website/docs/tools/evaluator.md similarity index 100% rename from docusaurus/docs/tools/evaluator.md rename to website/docs/tools/evaluator.md diff --git a/docusaurus/docs/tools/reporter.md b/website/docs/tools/reporter.md similarity index 100% rename from docusaurus/docs/tools/reporter.md rename to website/docs/tools/reporter.md diff --git a/docusaurus/docs/tools/scanner.md b/website/docs/tools/scanner.md similarity index 100% rename from docusaurus/docs/tools/scanner.md rename to website/docs/tools/scanner.md diff --git a/docusaurus/docusaurus.config.js b/website/docusaurus.config.js similarity index 100% rename from docusaurus/docusaurus.config.js rename to website/docusaurus.config.js diff --git a/docusaurus/package-lock.json b/website/package-lock.json similarity index 100% rename from docusaurus/package-lock.json rename to website/package-lock.json diff --git a/docusaurus/package.json b/website/package.json similarity index 100% rename from docusaurus/package.json rename to website/package.json diff --git a/docusaurus/sidebars.js b/website/sidebars.js similarity index 100% rename from docusaurus/sidebars.js rename to website/sidebars.js diff --git a/docusaurus/src/components/HomepageFeatures/index.js b/website/src/components/HomepageFeatures/index.js similarity index 100% rename from docusaurus/src/components/HomepageFeatures/index.js rename to website/src/components/HomepageFeatures/index.js diff --git a/docusaurus/src/components/HomepageFeatures/styles.module.css b/website/src/components/HomepageFeatures/styles.module.css similarity index 100% rename from docusaurus/src/components/HomepageFeatures/styles.module.css rename to website/src/components/HomepageFeatures/styles.module.css diff --git a/docusaurus/src/css/custom.css b/website/src/css/custom.css similarity index 100% rename from docusaurus/src/css/custom.css rename to website/src/css/custom.css diff --git a/docusaurus/src/pages/index.js b/website/src/pages/index.js similarity index 100% rename from docusaurus/src/pages/index.js rename to website/src/pages/index.js diff --git a/docusaurus/src/pages/index.module.css b/website/src/pages/index.module.css similarity index 100% rename from docusaurus/src/pages/index.module.css rename to website/src/pages/index.module.css diff --git a/docusaurus/static/.nojekyll b/website/static/.nojekyll similarity index 100% rename from docusaurus/static/.nojekyll rename to website/static/.nojekyll diff --git a/docusaurus/static/img/advisor.svg b/website/static/img/advisor.svg similarity index 100% rename from docusaurus/static/img/advisor.svg rename to website/static/img/advisor.svg diff --git a/docusaurus/static/img/analyzer.svg b/website/static/img/analyzer.svg similarity index 100% rename from docusaurus/static/img/analyzer.svg rename to website/static/img/analyzer.svg diff --git a/docusaurus/static/img/docusaurus.png b/website/static/img/docusaurus.png similarity index 100% rename from docusaurus/static/img/docusaurus.png rename to website/static/img/docusaurus.png diff --git a/docusaurus/static/img/downloader.svg b/website/static/img/downloader.svg similarity index 100% rename from docusaurus/static/img/downloader.svg rename to website/static/img/downloader.svg diff --git a/docusaurus/static/img/evaluator.svg b/website/static/img/evaluator.svg similarity index 100% rename from docusaurus/static/img/evaluator.svg rename to website/static/img/evaluator.svg diff --git a/docusaurus/static/img/favicon.ico b/website/static/img/favicon.ico similarity index 100% rename from docusaurus/static/img/favicon.ico rename to website/static/img/favicon.ico diff --git a/docusaurus/static/img/logo.svg b/website/static/img/logo.svg similarity index 100% rename from docusaurus/static/img/logo.svg rename to website/static/img/logo.svg diff --git a/docusaurus/static/img/ort.png b/website/static/img/ort.png similarity index 100% rename from docusaurus/static/img/ort.png rename to website/static/img/ort.png diff --git a/docusaurus/static/img/reporter.svg b/website/static/img/reporter.svg similarity index 100% rename from docusaurus/static/img/reporter.svg rename to website/static/img/reporter.svg diff --git a/docusaurus/static/img/scanner.svg b/website/static/img/scanner.svg similarity index 100% rename from docusaurus/static/img/scanner.svg rename to website/static/img/scanner.svg diff --git a/docusaurus/tutorial/intro.md b/website/tutorial/intro.md similarity index 100% rename from docusaurus/tutorial/intro.md rename to website/tutorial/intro.md