From 0afc355facb6f92f249661a107913c945befd047 Mon Sep 17 00:00:00 2001 From: Peter Macdonald Date: Fri, 15 Nov 2024 13:20:36 +0100 Subject: [PATCH] look into reorganising the Getting Started section to meet the CNCF recommendations Signed-off-by: Peter Macdonald --- docs/getting-started/concepts.md | 21 --------------------- docs/getting-started/index.md | 17 ++++++++++++++++- microsite/sidebars.js | 23 ++++++++++++++--------- 3 files changed, 30 insertions(+), 31 deletions(-) delete mode 100644 docs/getting-started/concepts.md diff --git a/docs/getting-started/concepts.md b/docs/getting-started/concepts.md deleted file mode 100644 index f8aba8537d..0000000000 --- a/docs/getting-started/concepts.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: concepts -title: Key Concepts -# prettier-ignore -description: High level key concepts used in the Backstage project ---- - -For users of Backstage, there are certain concepts which are central to its -design and functionality. Being an expert in each of these concepts is not -necessary, however having a base understanding of each will make administering, -configuring, and operating Backstage easier. - -- CHANGELOG - https://keepachangelog.com -- Docker - https://www.docker.com/ -- Monorepo - https://semaphoreci.com/blog/what-is-monorepo -- Node.js - https://nodejs.org -- React - https://reactjs.org -- Semantic Versioning - https://semver.org -- TypeScript - https://www.typescriptlang.org -- YAML - https://yaml.org -- Yarn - https://www.pluralsight.com/guides/yarn-a-package-manager-for-node-js diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 993cd7cbfd..c6c96963f9 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -21,7 +21,22 @@ If you are planning to contribute a new feature or bug fix to the Backstage proj ## Prerequisites -This guide assumes a basic understanding of working on a Linux based operating system and have some experience with the terminal, specifically, these commands: `npm`, `yarn`. +Before we dive in, its good to have an understanding of these concepts which are central to Backstage's +design and functionality. Being an expert in each of these concepts is not +necessary, however having a base understanding of each will make administering, developing, +configuring, and operating Backstage easier. + +- CHANGELOG - https://keepachangelog.com +- Docker - https://www.docker.com/ +- Monorepo - https://semaphoreci.com/blog/what-is-monorepo +- Node.js - https://nodejs.org +- React - https://reactjs.org +- Semantic Versioning - https://semver.org +- TypeScript - https://www.typescriptlang.org +- YAML - https://yaml.org +- Yarn - https://www.pluralsight.com/guides/yarn-a-package-manager-for-node-js + +This guide also assumes a basic understanding of working on a Linux based operating system and have some experience with the terminal, specifically, these commands: `npm`, `yarn`. - Access to a Unix-based operating system, such as Linux, macOS or [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/) diff --git a/microsite/sidebars.js b/microsite/sidebars.js index 871cec0a0f..51094abe5f 100644 --- a/microsite/sidebars.js +++ b/microsite/sidebars.js @@ -27,6 +27,19 @@ module.exports = { 'getting-started/homepage', ], }, + { + type: 'category', + label: 'Deploying Backstage', + items: [ + 'deployment/index', + 'deployment/scaling', + 'deployment/docker', + 'deployment/k8s', + 'deployment/heroku', + 'deployment/koyeb', + 'deployment/flightcontrol', + ], + }, { type: 'category', label: 'Using Backstage', @@ -36,8 +49,7 @@ module.exports = { 'getting-started/create-a-component', ], }, - 'getting-started/keeping-backstage-updated', - 'getting-started/concepts', + 'getting-started/keeping-backstage-updated' ], 'Core Features': [ { @@ -342,13 +354,6 @@ module.exports = { 'tooling/package-metadata', ], Deployment: [ - 'deployment/index', - 'deployment/scaling', - 'deployment/docker', - 'deployment/k8s', - 'deployment/heroku', - 'deployment/koyeb', - 'deployment/flightcontrol', { type: 'category', label: 'Using Backstage Deploy (alpha)',