From 06b924a3d6f093087c5bf3ec07f90b4477eb7d1b Mon Sep 17 00:00:00 2001 From: aramissennyeydd Date: Tue, 10 Dec 2024 18:29:32 -0700 Subject: [PATCH 1/6] chore: more sidebar consolidation Signed-off-by: aramissennyeydd --- docs/faq/product.md | 2 +- microsite/sidebars.js | 65 +++++++++++++++++++++++-------------------- 2 files changed, 36 insertions(+), 31 deletions(-) diff --git a/docs/faq/product.md b/docs/faq/product.md index edbb1ffb4d..f09b5696b8 100644 --- a/docs/faq/product.md +++ b/docs/faq/product.md @@ -1,6 +1,6 @@ --- id: product -title: Product FAQ +title: Non-technical FAQ description: Questions related to product and design. --- diff --git a/microsite/sidebars.js b/microsite/sidebars.js index e48e3b7b52..0e3837e5bc 100644 --- a/microsite/sidebars.js +++ b/microsite/sidebars.js @@ -4,15 +4,9 @@ module.exports = { docs: { Overview: [ 'overview/what-is-backstage', - 'overview/architecture-overview', - 'overview/roadmap', - 'overview/vision', 'overview/background', - 'overview/adopting', - 'overview/versioning-policy', - 'overview/threat-model', - 'overview/support', - 'overview/logos', + 'overview/vision', + 'overview/roadmap', ], 'Getting Started': [ 'getting-started/index', @@ -46,6 +40,7 @@ module.exports = { 'getting-started/create-a-component', ], }, + 'overview/support', 'getting-started/keeping-backstage-updated', ], 'Core Features': [ @@ -301,6 +296,7 @@ module.exports = { ], Plugins: [ 'plugins/index', + 'overview/architecture-overview', 'plugins/existing-plugins', 'plugins/create-a-plugin', 'plugins/plugin-development', @@ -489,34 +485,40 @@ module.exports = { ], }, ], - 'Designing for Backstage': [ - 'dls/design', - 'dls/component-design-guidelines', - 'dls/contributing-to-storybook', - 'dls/figma', - ], Tutorials: [ - 'tutorials/quickstart-app-plugin', - 'tutorials/react-router-stable-migration', - 'tutorials/react18-migration', - 'tutorials/package-role-migration', - 'tutorials/migrating-away-from-core', - 'tutorials/configuring-plugin-databases', - 'tutorials/switching-sqlite-postgres', - 'tutorials/using-backstage-proxy-within-plugin', - 'tutorials/yarn-migration', - 'tutorials/migrate-to-mui5', - 'tutorials/auth-service-migration', - 'tutorials/enable-public-entry', - 'tutorials/setup-opentelemetry', + { 'Non-technical': ['overview/adopting'] }, + { + Techical: [ + 'tutorials/quickstart-app-plugin', + 'tutorials/react-router-stable-migration', + 'tutorials/react18-migration', + 'tutorials/package-role-migration', + 'tutorials/migrating-away-from-core', + 'tutorials/configuring-plugin-databases', + 'tutorials/switching-sqlite-postgres', + 'tutorials/using-backstage-proxy-within-plugin', + 'tutorials/yarn-migration', + 'tutorials/migrate-to-mui5', + 'tutorials/auth-service-migration', + 'tutorials/enable-public-entry', + 'tutorials/setup-opentelemetry', + 'accessibility/index' + ], + }, ], - - FAQ: ['faq/index', 'faq/product', 'faq/technical'], - Accessibility: ['accessibility/index'], + FAQ: ['faq/index', 'faq/technical', 'faq/product'], Contribute: [ 'contribute/index', 'contribute/getting-involved', 'contribute/project-structure', + { + 'Designing for Backstage': [ + 'dls/design', + 'dls/component-design-guidelines', + 'dls/contributing-to-storybook', + 'dls/figma', + ], + }, ], References: [ { @@ -541,10 +543,13 @@ module.exports = { }, 'api/deprecations', 'references/glossary', + 'overview/threat-model', 'api/utility-apis', + 'overview/versioning-policy', 'reference/index', ], }, + Assets: ['overview/logos'], releases: { 'Release Notes': releases.map(release => `releases/${release}`), }, From 9019646784c930e8f7a003d865aa98a9cf622712 Mon Sep 17 00:00:00 2001 From: aramissennyeydd Date: Wed, 11 Dec 2024 18:03:37 -0700 Subject: [PATCH 2/6] fix prettier Signed-off-by: aramissennyeydd --- microsite/sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/microsite/sidebars.js b/microsite/sidebars.js index 0e3837e5bc..749b0a6a5f 100644 --- a/microsite/sidebars.js +++ b/microsite/sidebars.js @@ -502,7 +502,7 @@ module.exports = { 'tutorials/auth-service-migration', 'tutorials/enable-public-entry', 'tutorials/setup-opentelemetry', - 'accessibility/index' + 'accessibility/index', ], }, ], From e8207106b43b027af80ce39db16e4441e20dfcd3 Mon Sep 17 00:00:00 2001 From: aramissennyeydd Date: Sun, 29 Dec 2024 17:32:41 -0700 Subject: [PATCH 3/6] add security section Signed-off-by: aramissennyeydd --- microsite/sidebars.js | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/microsite/sidebars.js b/microsite/sidebars.js index 749b0a6a5f..de2333e765 100644 --- a/microsite/sidebars.js +++ b/microsite/sidebars.js @@ -543,7 +543,11 @@ module.exports = { }, 'api/deprecations', 'references/glossary', - 'overview/threat-model', + { + 'Security': [ + 'overview/threat-model', + ] + }, 'api/utility-apis', 'overview/versioning-policy', 'reference/index', From af8975b8abc3371266e4c0fe32d4766069e13026 Mon Sep 17 00:00:00 2001 From: aramissennyeydd Date: Sat, 4 Jan 2025 14:25:40 -0700 Subject: [PATCH 4/6] fix prettier Signed-off-by: aramissennyeydd --- microsite/sidebars.js | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/microsite/sidebars.js b/microsite/sidebars.js index de2333e765..d1230b9abd 100644 --- a/microsite/sidebars.js +++ b/microsite/sidebars.js @@ -544,9 +544,7 @@ module.exports = { 'api/deprecations', 'references/glossary', { - 'Security': [ - 'overview/threat-model', - ] + Security: ['overview/threat-model'], }, 'api/utility-apis', 'overview/versioning-policy', From 043c01d55dde3a014a902126b6288568b0aa3ad1 Mon Sep 17 00:00:00 2001 From: aramissennyeydd Date: Sat, 1 Feb 2025 11:15:13 -0500 Subject: [PATCH 5/6] update following sig meeting Signed-off-by: aramissennyeydd --- docs/overview/logos.md | 33 +-------------------------------- docs/overview/threat-model.md | 1 + microsite/docusaurus.config.ts | 4 ++++ microsite/sidebars.js | 31 +++++++++++++++---------------- 4 files changed, 21 insertions(+), 48 deletions(-) diff --git a/docs/overview/logos.md b/docs/overview/logos.md index fe993cc378..3198b38b71 100644 --- a/docs/overview/logos.md +++ b/docs/overview/logos.md @@ -7,36 +7,5 @@ description: Guidelines for how to use the Backstage logos and icons Guidelines for how to use the Backstage logo and icon can be found [here](https://backstage.io/logo_assets/Backstage_Identity_Assets_Overview.pdf). -The assets below are all in `.svg` format. Other formats are available in the -[repository](https://github.com/backstage/backstage/tree/master/microsite/static/logo_assets). -## Backstage logo - - - Backstage White logo - - - - Backstage Teal logo - - - - Backstage Black logo - - -## Backstage icon - - +You can find the assets at https://github.com/cncf/artwork/tree/main/projects/backstage. diff --git a/docs/overview/threat-model.md b/docs/overview/threat-model.md index 2461f002c8..6f06fbd527 100644 --- a/docs/overview/threat-model.md +++ b/docs/overview/threat-model.md @@ -1,6 +1,7 @@ --- id: threat-model title: Backstage Threat Model +sidebar_label: Security & Thread Model description: A document describing the threat model for Backstage. --- diff --git a/microsite/docusaurus.config.ts b/microsite/docusaurus.config.ts index 43bde19e35..38bf582d6b 100644 --- a/microsite/docusaurus.config.ts +++ b/microsite/docusaurus.config.ts @@ -405,6 +405,10 @@ const config: Config = { label: 'GitHub', to: 'https://github.com/backstage/', }, + { + label: 'Assets', + to: 'https://github.com/cncf/artwork/tree/main/projects/backstage' + } ], }, ], diff --git a/microsite/sidebars.js b/microsite/sidebars.js index d1230b9abd..244148fc4f 100644 --- a/microsite/sidebars.js +++ b/microsite/sidebars.js @@ -4,9 +4,12 @@ module.exports = { docs: { Overview: [ 'overview/what-is-backstage', + 'overview/architecture-overview', 'overview/background', 'overview/vision', 'overview/roadmap', + 'overview/threat-model', + 'overview/versioning-policy', ], 'Getting Started': [ 'getting-started/index', @@ -296,7 +299,6 @@ module.exports = { ], Plugins: [ 'plugins/index', - 'overview/architecture-overview', 'plugins/existing-plugins', 'plugins/create-a-plugin', 'plugins/plugin-development', @@ -490,27 +492,31 @@ module.exports = { { Techical: [ 'tutorials/quickstart-app-plugin', - 'tutorials/react-router-stable-migration', - 'tutorials/react18-migration', - 'tutorials/package-role-migration', - 'tutorials/migrating-away-from-core', 'tutorials/configuring-plugin-databases', 'tutorials/switching-sqlite-postgres', 'tutorials/using-backstage-proxy-within-plugin', - 'tutorials/yarn-migration', - 'tutorials/migrate-to-mui5', - 'tutorials/auth-service-migration', 'tutorials/enable-public-entry', 'tutorials/setup-opentelemetry', 'accessibility/index', ], }, + {Migrations: [ + 'tutorials/react-router-stable-migration', + 'tutorials/react18-migration', + 'tutorials/package-role-migration', + 'tutorials/migrating-away-from-core', + 'tutorials/yarn-migration', + 'tutorials/migrate-to-mui5', + 'tutorials/auth-service-migration', + ]} ], - FAQ: ['faq/index', 'faq/technical', 'faq/product'], + FAQ: ['faq/index', 'faq/product','faq/technical'], Contribute: [ 'contribute/index', 'contribute/getting-involved', 'contribute/project-structure', + ], + References: [ { 'Designing for Backstage': [ 'dls/design', @@ -519,8 +525,6 @@ module.exports = { 'dls/figma', ], }, - ], - References: [ { type: 'category', label: 'Architecture Decision Records (ADRs)', @@ -543,15 +547,10 @@ module.exports = { }, 'api/deprecations', 'references/glossary', - { - Security: ['overview/threat-model'], - }, 'api/utility-apis', - 'overview/versioning-policy', 'reference/index', ], }, - Assets: ['overview/logos'], releases: { 'Release Notes': releases.map(release => `releases/${release}`), }, From cce1c33d520c32d79265d8c3bdb615596defb043 Mon Sep 17 00:00:00 2001 From: aramissennyeydd Date: Mon, 3 Feb 2025 13:07:14 -0500 Subject: [PATCH 6/6] prettier :( Signed-off-by: aramissennyeydd --- microsite/docusaurus.config.ts | 4 ++-- microsite/sidebars.js | 22 ++++++++++++---------- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/microsite/docusaurus.config.ts b/microsite/docusaurus.config.ts index 38bf582d6b..e07ff68c18 100644 --- a/microsite/docusaurus.config.ts +++ b/microsite/docusaurus.config.ts @@ -407,8 +407,8 @@ const config: Config = { }, { label: 'Assets', - to: 'https://github.com/cncf/artwork/tree/main/projects/backstage' - } + to: 'https://github.com/cncf/artwork/tree/main/projects/backstage', + }, ], }, ], diff --git a/microsite/sidebars.js b/microsite/sidebars.js index 244148fc4f..d650925c20 100644 --- a/microsite/sidebars.js +++ b/microsite/sidebars.js @@ -500,17 +500,19 @@ module.exports = { 'accessibility/index', ], }, - {Migrations: [ - 'tutorials/react-router-stable-migration', - 'tutorials/react18-migration', - 'tutorials/package-role-migration', - 'tutorials/migrating-away-from-core', - 'tutorials/yarn-migration', - 'tutorials/migrate-to-mui5', - 'tutorials/auth-service-migration', - ]} + { + Migrations: [ + 'tutorials/react-router-stable-migration', + 'tutorials/react18-migration', + 'tutorials/package-role-migration', + 'tutorials/migrating-away-from-core', + 'tutorials/yarn-migration', + 'tutorials/migrate-to-mui5', + 'tutorials/auth-service-migration', + ], + }, ], - FAQ: ['faq/index', 'faq/product','faq/technical'], + FAQ: ['faq/index', 'faq/product', 'faq/technical'], Contribute: [ 'contribute/index', 'contribute/getting-involved',