From aa9bcba113e1e8fef66c4917002a38a81b9efbbc Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 24 Mar 2021 14:31:00 -0400 Subject: [PATCH 1/4] Clarify contributing Signed-off-by: Adam Harvey --- docs/getting-started/index.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 2536944a7c..13b52181df 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -42,6 +42,13 @@ this process in [Create an app](./create-an-app.md). ### Contributing to Backstage +If you intend to make changes to the core project's packages, certain plugins, +or project documentation, then you can fork and clone +[https://github.com/backstage/backstage](https://github.com/backstage/backstage). + +This will let you run the latest code off of the `master` branch, fix bugs or +contribute new features, run test suites, etc. + You can read more in our [CONTRIBUTING](https://github.com/backstage/backstage/blob/master/CONTRIBUTING.md) guide, which can help you get setup with a Backstage development environment. From 1f2bdb81c4751478b5e34e0b6e3441030af4d89c Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 24 Mar 2021 14:31:15 -0400 Subject: [PATCH 2/4] Add Key Concepts page Signed-off-by: Adam Harvey --- docs/getting-started/concepts.md | 20 ++++++++++++++++++++ microsite/sidebars.json | 1 + 2 files changed, 21 insertions(+) create mode 100644 docs/getting-started/concepts.md diff --git a/docs/getting-started/concepts.md b/docs/getting-started/concepts.md new file mode 100644 index 0000000000..7f2e020a07 --- /dev/null +++ b/docs/getting-started/concepts.md @@ -0,0 +1,20 @@ +--- +id: concepts +title: Key Concepts +# prettier-ignore +description: High level of key concepts used in the Backstage project +--- + +For new users to Backstage, there are certain concepts which are central to it'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, +configuring, and operating Backstage easier to understand. + +- CHANGELOG - https://keepachangelog.com +- Docker - https://www.docker.com/ +- Monorepo - https://semaphoreci.com/blog/what-is-monorepo +- 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/microsite/sidebars.json b/microsite/sidebars.json index e6dba1386d..a41a77115f 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -33,6 +33,7 @@ ] }, "getting-started/keeping-backstage-updated", + "getting-started/concepts", "getting-started/contributors" ], "CLI": ["cli/index", "cli/commands"], From 3846a67f046523912114c68ccd9ef1a400ac15c5 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 24 Mar 2021 14:35:48 -0400 Subject: [PATCH 3/4] Fix typo Signed-off-by: Adam Harvey --- docs/getting-started/concepts.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/concepts.md b/docs/getting-started/concepts.md index 7f2e020a07..f58d742a98 100644 --- a/docs/getting-started/concepts.md +++ b/docs/getting-started/concepts.md @@ -5,7 +5,7 @@ title: Key Concepts description: High level of key concepts used in the Backstage project --- -For new users to Backstage, there are certain concepts which are central to it's +For new users to 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 to understand. @@ -13,6 +13,7 @@ configuring, and operating Backstage easier to understand. - 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 From 7cb67326c4c6553a745efde5f857b4e691a3babd Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 24 Mar 2021 14:52:49 -0400 Subject: [PATCH 4/4] Apply feedback Signed-off-by: Adam Harvey --- docs/getting-started/concepts.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/concepts.md b/docs/getting-started/concepts.md index f58d742a98..f8aba8537d 100644 --- a/docs/getting-started/concepts.md +++ b/docs/getting-started/concepts.md @@ -2,13 +2,13 @@ id: concepts title: Key Concepts # prettier-ignore -description: High level of key concepts used in the Backstage project +description: High level key concepts used in the Backstage project --- -For new users to Backstage, there are certain concepts which are central to its +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 to understand. +configuring, and operating Backstage easier. - CHANGELOG - https://keepachangelog.com - Docker - https://www.docker.com/