diff --git a/docs/getting-started/concepts.md b/docs/getting-started/concepts.md new file mode 100644 index 0000000000..f8aba8537d --- /dev/null +++ b/docs/getting-started/concepts.md @@ -0,0 +1,21 @@ +--- +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 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. 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"],