diff --git a/.github/workflows/deploy_microsite.yml b/.github/workflows/deploy_microsite.yml index d9f2680c57..2c9ebdf36a 100644 --- a/.github/workflows/deploy_microsite.yml +++ b/.github/workflows/deploy_microsite.yml @@ -69,17 +69,6 @@ jobs: with: cache-prefix: ${{ runner.os }}-v22.x - - name: build API reference - run: yarn build:api-docs - - - name: upload API reference - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 - with: - name: stable-reference - path: docs/reference/ - if-no-files-found: error - retention-days: 1 - # Use the lower-level cache actions for the success cache, so that we can store the cache even on failed builds - name: restore package-docs cache uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4 @@ -89,13 +78,13 @@ jobs: restore-keys: | ${{ runner.os }}-v${{ matrix.node-version }}-package-docs-stable- - - name: build API reference (beta) + - name: build API reference run: yarn backstage-repo-tools package-docs - - name: upload API reference (beta) + - name: upload API reference uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: - name: stable-reference-beta + name: stable-reference path: type-docs/ if-no-files-found: error retention-days: 1 @@ -153,17 +142,6 @@ jobs: with: cache-prefix: ${{ runner.os }}-v22.x - - name: build API reference - run: yarn build:api-docs - - - name: upload API reference - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 - with: - name: next-reference - path: docs/reference/ - if-no-files-found: error - retention-days: 1 - # Use the lower-level cache actions for the success cache, so that we can store the cache even on failed builds - name: restore package-docs cache uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4 @@ -173,13 +151,13 @@ jobs: restore-keys: | ${{ runner.os }}-v${{ matrix.node-version }}-package-docs- - - name: build API reference (beta) + - name: build API reference run: yarn backstage-repo-tools package-docs - - name: upload API reference (beta) + - name: upload API reference uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: - name: next-reference-beta + name: next-reference path: type-docs/ if-no-files-found: error retention-days: 1 @@ -260,12 +238,6 @@ jobs: run: yarn install --immutable working-directory: microsite - - name: download stable reference - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 - with: - name: stable-reference - path: docs/reference - - name: download stable OpenAPI API docs uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 with: @@ -294,12 +266,6 @@ jobs: run: yarn install --immutable working-directory: microsite - - name: download next reference - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 - with: - name: next-reference - path: docs/reference - - name: download next OpenAPI API docs uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 with: @@ -317,12 +283,12 @@ jobs: - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 with: - name: stable-reference-beta + name: stable-reference path: microsite/build/api/stable/ - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 with: - name: next-reference-beta + name: next-reference path: microsite/build/api/next/ - name: Check the build output diff --git a/.github/workflows/verify_microsite.yml b/.github/workflows/verify_microsite.yml index b4faa8826d..472c710984 100644 --- a/.github/workflows/verify_microsite.yml +++ b/.github/workflows/verify_microsite.yml @@ -74,17 +74,6 @@ jobs: with: cache-prefix: ${{ runner.os }}-v22.x - - name: build API reference - run: yarn build:api-docs - - - name: upload API reference - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 - with: - name: stable-reference - path: docs/reference/ - if-no-files-found: error - retention-days: 1 - # Use the lower-level cache actions for the success cache, so that we can store the cache even on failed builds - name: restore package-docs cache uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4 @@ -94,13 +83,13 @@ jobs: restore-keys: | ${{ runner.os }}-v${{ matrix.node-version }}-package-docs-stable- - - name: build API reference (beta) + - name: build API reference run: yarn backstage-repo-tools package-docs - - name: upload API reference (beta) + - name: upload API reference uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: - name: stable-reference-beta + name: stable-reference path: type-docs/ # Always save success cache even if there were failures, that way it can be used in re-triggered builds @@ -155,17 +144,6 @@ jobs: with: cache-prefix: ${{ runner.os }}-v22.x - - name: build API reference - run: yarn build:api-docs - - - name: upload API reference - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 - with: - name: next-reference - path: docs/reference/ - if-no-files-found: error - retention-days: 1 - # Use the lower-level cache actions for the success cache, so that we can store the cache even on failed builds - name: restore package-docs cache uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4 @@ -175,13 +153,13 @@ jobs: restore-keys: | ${{ runner.os }}-v${{ matrix.node-version }}-package-docs-next- - - name: build API reference (beta) + - name: build API reference run: yarn backstage-repo-tools package-docs - - name: upload API reference (beta) + - name: upload API reference uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: - name: next-reference-beta + name: next-reference path: type-docs/ # Always save success cache even if there were failures, that way it can be used in re-triggered builds @@ -267,12 +245,6 @@ jobs: - name: verify yarn dependency duplicates run: node scripts/verify-lockfile-duplicates.js - - name: download stable reference - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 - with: - name: stable-reference - path: docs/reference - - name: download stable OpenAPI API docs uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 with: @@ -291,9 +263,6 @@ jobs: - name: clear generated docs run: git clean -fdx docs/ - - name: build API reference - run: yarn build:api-docs - - name: checkout master uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 with: @@ -302,12 +271,6 @@ jobs: - name: Build MkDocs for TechDocs run: mkdocs build --strict - - name: download next reference - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 - with: - name: next-reference - path: docs/reference - - name: download next OpenAPI API docs uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 with: @@ -317,15 +280,3 @@ jobs: - name: build microsite run: yarn build working-directory: microsite - - - name: download stable reference (beta) - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 - with: - name: stable-reference-beta - path: api/stable/ - - - name: download next reference (beta) - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 - with: - name: next-reference-beta - path: api/next/ diff --git a/docs/references/index.md b/docs/references/index.md new file mode 100644 index 0000000000..abd5c99c0c --- /dev/null +++ b/docs/references/index.md @@ -0,0 +1,7 @@ +--- +id: 'index' +title: 'Package Index' +description: 'Index of all Backstage Packages' +--- + +Please use [the new API documentation](https://backstage.io/api/stable) for more information. diff --git a/microsite/package.json b/microsite/package.json index edf07abb02..8087d96b19 100644 --- a/microsite/package.json +++ b/microsite/package.json @@ -4,7 +4,7 @@ "private": true, "license": "Apache-2.0", "scripts": { - "build": "node scripts/pre-build.js && docusaurus build", + "build": "docusaurus build", "deploy": "docusaurus deploy", "docusaurus": "docusaurus", "generate-openapi-docs": "yarn docusaurus clean-api-docs all && yarn docusaurus gen-api-docs all", @@ -12,7 +12,7 @@ "prettier:fix": "prettier --write .", "publish-gh-pages": "docusaurus-publish", "rename-version": "docusaurus-rename-version", - "start": "node scripts/pre-build.js && docusaurus start", + "start": "docusaurus start", "swizzle": "docusaurus swizzle", "verify:sidebars": "node ./scripts/verify-sidebars", "version": "docusaurus-version", diff --git a/microsite/scripts/pre-build.js b/microsite/scripts/pre-build.js deleted file mode 100644 index 3b5bd4fb0b..0000000000 --- a/microsite/scripts/pre-build.js +++ /dev/null @@ -1,39 +0,0 @@ -/* - * Copyright 2022 The Backstage Authors - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -const { existsSync, writeFileSync, mkdirSync } = require('fs'); -const path = require('path'); - -const PLACEHOLDER = `--- -id: "index" -title: "Package Index" -description: "Index of all Backstage Packages" ---- -Run \`yarn build:api-docs\` to generate the API docs. -`; - -async function main() { - const referencesDir = '../docs/reference'; - if (!existsSync(referencesDir)) { - mkdirSync(referencesDir); - writeFileSync(path.join(referencesDir, 'index.md'), PLACEHOLDER); - } -} - -main().catch(error => { - console.error(error.stack); - process.exit(1); -}); diff --git a/microsite/sidebars.ts b/microsite/sidebars.ts index fed5de8015..33bee593f8 100644 --- a/microsite/sidebars.ts +++ b/microsite/sidebars.ts @@ -750,7 +750,7 @@ export default { 'api/deprecations', 'references/glossary', 'api/utility-apis', - 'reference/index', + 'references/index', ], ), ],