Merge pull request #31690 from backstage/sennyeya/disable-ref-build

chore: disable old api reference generation
This commit is contained in:
Patrik Oldsberg
2026-01-22 15:14:13 +01:00
committed by GitHub
6 changed files with 24 additions and 139 deletions
+2 -2
View File
@@ -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",
-39
View File
@@ -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);
});
+1 -1
View File
@@ -750,7 +750,7 @@ export default {
'api/deprecations',
'references/glossary',
'api/utility-apis',
'reference/index',
'references/index',
],
),
],