From 5509b5a8291546cc05f2dd1ece1c16cdec888e1f Mon Sep 17 00:00:00 2001 From: blam Date: Wed, 11 Sep 2024 12:13:33 +0200 Subject: [PATCH] chore: smol fix Signed-off-by: blam --- docs/architecture-decisions/index.md | 2 +- docs/contribute/project-structure.md | 2 +- docs/publishing.md | 2 +- microsite/README.md | 25 +++++++++++++------------ mkdocs.yml | 2 +- 5 files changed, 17 insertions(+), 16 deletions(-) diff --git a/docs/architecture-decisions/index.md b/docs/architecture-decisions/index.md index 615d737fe1..3432264453 100644 --- a/docs/architecture-decisions/index.md +++ b/docs/architecture-decisions/index.md @@ -27,7 +27,7 @@ Records should be stored under the `architecture-decisions` directory. - Address and integrate feedback from the community - Eventually, assign a number - Add the path of the ADR to the microsite sidebar in - [`sidebars.json`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.json) + [`sidebars.js`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.js) - Add the path of the ADR to the [`mkdocs.yml`](https://github.com/backstage/backstage/blob/master/mkdocs.yml) - Merge the pull request diff --git a/docs/contribute/project-structure.md b/docs/contribute/project-structure.md index f06fba0523..32a692e700 100644 --- a/docs/contribute/project-structure.md +++ b/docs/contribute/project-structure.md @@ -39,7 +39,7 @@ the code. - [`docs/`](https://github.com/backstage/backstage/tree/master/docs) - This is where we keep all of our documentation Markdown files. These end up on https://backstage.io/docs. Just keep in mind that changes to the - [`sidebars.json`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.json) + [`sidebars.js`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.js) file may be needed as sections are added/removed. - [`.editorconfig`](https://github.com/backstage/backstage/tree/master/.editorconfig) - diff --git a/docs/publishing.md b/docs/publishing.md index 50d78ebf09..740292949f 100644 --- a/docs/publishing.md +++ b/docs/publishing.md @@ -51,7 +51,7 @@ Additional steps for the main line release - Mention any security fixes - Create Release Notes PR - Add the release note file as [`/docs/releases/vx.y.0.md`](./releases) - - Add an entry to [`/microsite/sidebar.json`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.json) for the release note + - Add an entry to [`/microsite/sidebar.js`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.js) for the release note - Update the navigation bar item in [`/microsite/docusaurus.config.ts`](https://github.com/backstage/backstage/blob/master/microsite/docusaurus.config.ts) to point to the new release note - Finally copy the content, without the metadata header, into the description of the [`Version Packages` Pull Request](https://github.com/backstage/backstage/pulls?q=is%3Aopen+is%3Apr+in%3Atitle+%22Version+Packages) diff --git a/microsite/README.md b/microsite/README.md index 5bd20254b6..62a28fb6a3 100644 --- a/microsite/README.md +++ b/microsite/README.md @@ -61,7 +61,7 @@ my-docusaurus/ css/ img/ package.json - sidebars.json + sidebars.js siteConfig.js ``` @@ -116,19 +116,20 @@ For more information about blog posts, click [here](https://docusaurus.io/docs/e My new content here.. ``` -2. Refer to that doc's ID in an existing sidebar in `website/sidebars.json`: +2. Refer to that doc's ID in an existing sidebar in `website/sidebars.js`: - ```javascript + ```js // Add newly-created-doc to the Getting Started category of docs - { - "docs": { - "Getting Started": [ - "quick-start", - "newly-created-doc" // new doc here - ], - ... - }, - ... + module.exports = { + ... + docs: { + "Getting Started": [ + "quick-start", + "newly-created-doc" // new doc here + ], + ... + }, + ... } ``` diff --git a/mkdocs.yml b/mkdocs.yml index d907e580a8..b2d0a5489d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,7 +6,7 @@ edit_uri: edit/master/docs plugins: - techdocs-core -# For sidebar navigation on https://backstage.io/, see `microsite/sidebars.json` +# For sidebar navigation on https://backstage.io/, see `microsite/sidebars.js` nav: - Overview: - What is Backstage?: 'overview/what-is-backstage.md'