Merge pull request #17643 from adamdmharvey/adamdmharvey/cicd-mkdocs

feat(pipeline): Add MkDocs verification & fix MkDocs nav warnings

.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:

.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:
@@ -37,6 +39,12 @@ 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
+
       - name: verify yarn dependency duplicates
         run: node scripts/verify-lockfile-duplicates.js
 

.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

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-v1beta3.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,7 +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'
-  - Glossary: glossary.md
   - FAQ: FAQ.md