From 61768175020c61d6e99aa812d94b503da2c32363 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20=C3=85lund?= Date: Sun, 15 Mar 2020 21:28:29 +0100 Subject: [PATCH] Put getting started back in README --- README.md | 34 +++++++++++++++---- docs/getting-started/README.md | 2 -- .../getting-started/create-run-an-instance.md | 15 -------- docs/getting-started/set-up-environment.md | 11 ------ 4 files changed, 28 insertions(+), 34 deletions(-) delete mode 100644 docs/getting-started/create-run-an-instance.md delete mode 100644 docs/getting-started/set-up-environment.md diff --git a/README.md b/README.md index f8a56714f2..f7df8190c9 100644 --- a/README.md +++ b/README.md @@ -39,16 +39,38 @@ _\* not yet released_ ![overview](backstage_overview.png) +## Getting started + +To run the Backstage frontend, you will need to have the following installed: + +- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) +- [NodeJS](https://nodejs.org/en/download/) - Active LTS Release, currently v12 +- [yarn](https://classic.yarnpkg.com/en/docs/install) + +Open a terminal window and start the web app using the following commands from the project root: + +```bash +$ yarn # may take a while + +$ yarn start +``` + +The final `yarn start` command should open a local instance of Backstage in your browser, otherwise open one of the URLs printed in the terminal. + ## Documentation -[Find the docs here.](docs/README.md) +- [Create a Plugin](docs/getting-started/create-a-plugin.md) +- [Structure of a Plugin](docs/getting-started/structure-of-a-plugin.md) +- [Frontend architecture](docs/architecture-terminology.md) +- [API references](docs/reference/README.md) +- Using Backstage components (TODO) -## Developer support +## Community -Please join our [Discord](https://discordapp.com/) server: - -- [#general](https://discord.gg/MUpMjP2) - Developer focused discussions -- [#support](https://discord.gg/dKhwsBp) - Support in how to use Backstage +- [Discord chat](https://discord.gg/MUpMjP2) - Get support or discuss the project +- [Good First Issues](https://github.com/spotify/backstage/labels/good%20first%20issue) - Start here if you want to contribute +- [Code of Conduct](CODE_OF_CONDUCT.md) - This is how we roll +- Give us a star ⭐️ - If you are using Backstage or think it is an interesting project, we would love a star ❤️ ## License diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index 16f405dcb9..c37e61e82f 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -2,8 +2,6 @@ Here is a collection of tutorials that will guide you through setting up and extending an instance of Backstage with your own plugins. -- [Set up the environment](set-up-environment.md) -- [Create/Run an instance of Backstage](create-run-an-instance.md) - [Create a Backstage plugin](create-a-plugin.md) - [Structure of a plugin](structure-of-a-plugin.md) - Using Backstage components (TODO) diff --git a/docs/getting-started/create-run-an-instance.md b/docs/getting-started/create-run-an-instance.md deleted file mode 100644 index 65754beb21..0000000000 --- a/docs/getting-started/create-run-an-instance.md +++ /dev/null @@ -1,15 +0,0 @@ -# Run an instance of Backstage - -Open a terminal window and start the web app using the following commands from the project root: - -```bash -$ yarn # may take a while - -$ yarn start -``` - -The final `yarn start` command should open a local instance of Backstage in your browser, otherwise open one of the URLs printed in the terminal. - -[Next step - Create a Backstage plugin](./create-a-plugin.md) - -[Back to Getting Started](README.md) diff --git a/docs/getting-started/set-up-environment.md b/docs/getting-started/set-up-environment.md deleted file mode 100644 index eb57609f79..0000000000 --- a/docs/getting-started/set-up-environment.md +++ /dev/null @@ -1,11 +0,0 @@ -### Set up environment - -To run the frontend, you will need to have the following installed: - -- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) -- [NodeJS](https://nodejs.org/en/download/) - Active LTS Release, currently v12 -- [yarn](https://classic.yarnpkg.com/en/docs/install) - -[Next step - Run an instance of the Backstage app](./create-run-an-instance.md) - -[Back to Getting Started](README.md)