From dfe4cab0c1726e5bb0a9029978920b160d3c0bf0 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 3 May 2023 20:08:58 -0400 Subject: [PATCH 01/12] feat: Add pipeline verification of the MkDocs configuration Signed-off-by: Adam Harvey --- .github/workflows/verify_techdocs_mkdocs.yml | 21 ++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .github/workflows/verify_techdocs_mkdocs.yml diff --git a/.github/workflows/verify_techdocs_mkdocs.yml b/.github/workflows/verify_techdocs_mkdocs.yml new file mode 100644 index 0000000000..7bd08c60fa --- /dev/null +++ b/.github/workflows/verify_techdocs_mkdocs.yml @@ -0,0 +1,21 @@ +name: Verify TechDocs MkDocs +on: + pull_request: + paths: + - 'docs/**' + - 'mkdocs.yml' + +jobs: + build-mkdocs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + + - name: Install dependencies + run: pip3 install mkdocs mkdocs-techdocs-core + + - name: Build MkDocs for TechDocs + run: mkdocs build --strict From a742e89bd38a3cf47e47608c16bb0392701b9a7a Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 3 May 2023 20:11:15 -0400 Subject: [PATCH 02/12] fix: Remove invalid Glossary item in nav Signed-off-by: Adam Harvey --- mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 742b3e2ca6..724932de06 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -211,5 +211,4 @@ nav: - ADR013 - Plugin Package Structure: 'architecture-decisions/adr013-use-node-fetch.md' - Support: - Backstage Project Structure: 'support/project-structure.md' - - Glossary: glossary.md - FAQ: FAQ.md From dd436dae1907b1d86af5d140219e9bb5206cb3bb Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 3 May 2023 20:17:59 -0400 Subject: [PATCH 03/12] fix: Remove invalid files from the nav Signed-off-by: Adam Harvey --- mkdocs.yml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 724932de06..c6512af231 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -66,12 +66,10 @@ nav: - Builtin Actions: 'features/software-templates/builtin-actions.md' - Writing Custom Actions: 'features/software-templates/writing-custom-actions.md' - Writing Custom Step Layouts: 'features/software-templates/writing-custom-step-layouts.md' - - Writing Templates (Legacy): 'features/software-templates/legacy.md' - - Migrating from v1alpha1 to v1beta2 templates: 'features/software-templates/migrating-from-v1alpha1-to-v1beta2.md' + - Migrating from v1beta2 to v1beta3 templates: 'features/software-templates/migrating-from-v1beta2-to-v2beta3.md' - Backstage Search: - Overview: 'features/search/README.md' - Getting Started: 'features/search/getting-started.md' - - Getting Started, configuring Backstage: 'features/search/configuration.md' - Concepts: 'features/search/concepts.md' - Search Architecture: 'features/search/architecture.md' - Search Engines: 'features/search/search-engines.md' @@ -98,8 +96,6 @@ nav: - Locations: 'integrations/azure/locations.md' - Discovery: 'integrations/azure/discovery.md' - Org Data: 'integrations/azure/org.md' - - Bitbucket: - - Discovery: 'integrations/bitbucket/discovery.md' - Bitbucket Cloud: - Locations: 'integrations/bitbucketCloud/locations.md' - Discovery: 'integrations/bitbucketCloud/discovery.md' @@ -209,6 +205,4 @@ nav: - ADR011 - Plugin Package Structure: 'architecture-decisions/adr011-plugin-package-structure.md' - ADR012 - Plugin Package Structure: 'architecture-decisions/adr012-use-luxon-locale-and-date-presets.md' - ADR013 - Plugin Package Structure: 'architecture-decisions/adr013-use-node-fetch.md' - - Support: - - Backstage Project Structure: 'support/project-structure.md' - FAQ: FAQ.md From 873728f394d30481ed85f9747bd58419fb5fef34 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 3 May 2023 20:23:21 -0400 Subject: [PATCH 04/12] chore: Fix comment typo Signed-off-by: Adam Harvey --- .github/workflows/verify_storybook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/verify_storybook.yml b/.github/workflows/verify_storybook.yml index 42326fd71d..92d6222b52 100644 --- a/.github/workflows/verify_storybook.yml +++ b/.github/workflows/verify_storybook.yml @@ -49,7 +49,7 @@ jobs: - uses: chromaui/action@v1 with: token: ${{ secrets.GITHUB_TOKEN }} - # projetToken intentionally shared to allow collaborators to run Chromatic on forks + # projectToken intentionally shared to allow collaborators to run Chromatic on forks # https://www.chromatic.com/docs/custom-ci-provider#run-chromatic-on-external-forks-of-open-source-projects projectToken: 9tzak77m9nj workingDir: storybook From f48b44e3583e85ba49862d6fda50a71e858e8b49 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 3 May 2023 20:23:44 -0400 Subject: [PATCH 05/12] chore: Build API reference so it can be cross referenced Signed-off-by: Adam Harvey --- .github/workflows/verify_techdocs_mkdocs.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/.github/workflows/verify_techdocs_mkdocs.yml b/.github/workflows/verify_techdocs_mkdocs.yml index 7bd08c60fa..6d83ed0772 100644 --- a/.github/workflows/verify_techdocs_mkdocs.yml +++ b/.github/workflows/verify_techdocs_mkdocs.yml @@ -10,6 +10,25 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 + + # Generate the API Reference docs which MkDocs cross-references + + - name: use node.js 18.x + uses: actions/setup-node@v3 + with: + node-version: 18.x + + - name: yarn install + uses: backstage/actions/yarn-install@v0.6.3 + with: + cache-prefix: ${{ runner.os }}-v18.x + + - name: build API reference + run: yarn build:api-docs + + + # Setup and start the MkDocs configuration + - uses: actions/setup-python@v4 with: python-version: '3.10' From 22c0334610ae30dd03931f9af4673d01dc46a055 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 3 May 2023 20:28:20 -0400 Subject: [PATCH 06/12] chore: Increase memory Signed-off-by: Adam Harvey --- .github/workflows/verify_techdocs_mkdocs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/verify_techdocs_mkdocs.yml b/.github/workflows/verify_techdocs_mkdocs.yml index 6d83ed0772..c92aa3f4c8 100644 --- a/.github/workflows/verify_techdocs_mkdocs.yml +++ b/.github/workflows/verify_techdocs_mkdocs.yml @@ -8,6 +8,9 @@ on: jobs: build-mkdocs: runs-on: ubuntu-latest + env: + CI: true + NODE_OPTIONS: --max-old-space-size=4096 steps: - uses: actions/checkout@v3 From 9297559f828f4dff8e967861efbb43bbe855a644 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 3 May 2023 20:37:42 -0400 Subject: [PATCH 07/12] fix: software template nav filename Signed-off-by: Adam Harvey --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index c6512af231..8c29645840 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -66,7 +66,7 @@ nav: - Builtin Actions: 'features/software-templates/builtin-actions.md' - Writing Custom Actions: 'features/software-templates/writing-custom-actions.md' - Writing Custom Step Layouts: 'features/software-templates/writing-custom-step-layouts.md' - - Migrating from v1beta2 to v1beta3 templates: 'features/software-templates/migrating-from-v1beta2-to-v2beta3.md' + - Migrating from v1beta2 to v1beta3 templates: 'features/software-templates/migrating-from-v1beta2-to-v1beta3.md' - Backstage Search: - Overview: 'features/search/README.md' - Getting Started: 'features/search/getting-started.md' From dab23038c43a4da4eb226a97d4049860ba31af0c Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 3 May 2023 20:53:52 -0400 Subject: [PATCH 08/12] chore: Prettier formatting Signed-off-by: Adam Harvey --- .github/workflows/verify_techdocs_mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/verify_techdocs_mkdocs.yml b/.github/workflows/verify_techdocs_mkdocs.yml index c92aa3f4c8..288afa238b 100644 --- a/.github/workflows/verify_techdocs_mkdocs.yml +++ b/.github/workflows/verify_techdocs_mkdocs.yml @@ -29,7 +29,6 @@ jobs: - name: build API reference run: yarn build:api-docs - # Setup and start the MkDocs configuration - uses: actions/setup-python@v4 From 79ec83067415d30abddbb682e9842cd3931cfc56 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 16 May 2023 15:25:12 -0400 Subject: [PATCH 09/12] feat: Add MkDocs strict to check nav Signed-off-by: Adam Harvey --- .github/workflows/verify_microsite.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/verify_microsite.yml b/.github/workflows/verify_microsite.yml index e5037684e9..3d1da77ac4 100644 --- a/.github/workflows/verify_microsite.yml +++ b/.github/workflows/verify_microsite.yml @@ -37,6 +37,9 @@ jobs: - name: build API reference run: yarn build:api-docs + - name: Build MkDocs for TechDocs + run: mkdocs build --strict + - name: verify yarn dependency duplicates run: node scripts/verify-lockfile-duplicates.js From 9c8d98b2cf7c75187402b509716729ee9f8500b0 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 16 May 2023 15:25:39 -0400 Subject: [PATCH 10/12] chore: Remove new workflow Signed-off-by: Adam Harvey --- .github/workflows/verify_techdocs_mkdocs.yml | 42 -------------------- 1 file changed, 42 deletions(-) delete mode 100644 .github/workflows/verify_techdocs_mkdocs.yml diff --git a/.github/workflows/verify_techdocs_mkdocs.yml b/.github/workflows/verify_techdocs_mkdocs.yml deleted file mode 100644 index 288afa238b..0000000000 --- a/.github/workflows/verify_techdocs_mkdocs.yml +++ /dev/null @@ -1,42 +0,0 @@ -name: Verify TechDocs MkDocs -on: - pull_request: - paths: - - 'docs/**' - - 'mkdocs.yml' - -jobs: - build-mkdocs: - runs-on: ubuntu-latest - env: - CI: true - NODE_OPTIONS: --max-old-space-size=4096 - steps: - - uses: actions/checkout@v3 - - # Generate the API Reference docs which MkDocs cross-references - - - name: use node.js 18.x - uses: actions/setup-node@v3 - with: - node-version: 18.x - - - name: yarn install - uses: backstage/actions/yarn-install@v0.6.3 - with: - cache-prefix: ${{ runner.os }}-v18.x - - - name: build API reference - run: yarn build:api-docs - - # Setup and start the MkDocs configuration - - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - - name: Install dependencies - run: pip3 install mkdocs mkdocs-techdocs-core - - - name: Build MkDocs for TechDocs - run: mkdocs build --strict From 8983bd53a6a50fec72183ec5677686edaaab206c Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 16 May 2023 15:28:49 -0400 Subject: [PATCH 11/12] chore: Improve paths for Microsite actions Signed-off-by: Adam Harvey --- .github/workflows/verify_microsite-noop.yml | 2 ++ .github/workflows/verify_microsite.yml | 2 ++ 2 files changed, 4 insertions(+) diff --git a/.github/workflows/verify_microsite-noop.yml b/.github/workflows/verify_microsite-noop.yml index 0fa23812f5..cca7e512c5 100644 --- a/.github/workflows/verify_microsite-noop.yml +++ b/.github/workflows/verify_microsite-noop.yml @@ -6,7 +6,9 @@ on: pull_request: paths-ignore: - '.github/workflows/verify_microsite-next.yml' + - '.github/workflows/verify_microsite.yml' - 'microsite/**' + - 'mkdocs.yml' - 'docs/**' jobs: diff --git a/.github/workflows/verify_microsite.yml b/.github/workflows/verify_microsite.yml index 3d1da77ac4..9bb662f21c 100644 --- a/.github/workflows/verify_microsite.yml +++ b/.github/workflows/verify_microsite.yml @@ -4,7 +4,9 @@ on: pull_request: paths: - '.github/workflows/verify_microsite-next.yml' + - '.github/workflows/verify_microsite.yml' - 'microsite/**' + - 'mkdocs.yml' - 'docs/**' jobs: From 01dea69d26fc65209b62496728e283a3fb78b1a3 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 16 May 2023 16:27:47 -0400 Subject: [PATCH 12/12] fix: Install MkDocs dependencies Signed-off-by: Adam Harvey --- .github/workflows/verify_microsite.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/verify_microsite.yml b/.github/workflows/verify_microsite.yml index 9bb662f21c..d219d0ea74 100644 --- a/.github/workflows/verify_microsite.yml +++ b/.github/workflows/verify_microsite.yml @@ -39,6 +39,9 @@ jobs: - name: build API reference run: yarn build:api-docs + - name: Install MkDocs dependencies + run: pip3 install mkdocs mkdocs-techdocs-core + - name: Build MkDocs for TechDocs run: mkdocs build --strict