diff --git a/README.md b/README.md index c012638e7d..70abaa7a65 100644 --- a/README.md +++ b/README.md @@ -59,23 +59,25 @@ To run a Backstage app, you will need to have the following installed: - [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: +After cloning this repo, open a terminal window and start the web app using the following commands from the project root: ```bash -$ yarn install # may take a while - -$ yarn start +yarn install +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. -For more complex development environment configuration, see the -[Development Environment](docs/getting-started/development-environment.md) section of the Getting Started docs. +And thats it! You are good to go 👍 + +### Next step + +Take a look at the [Getting Started](docs/getting-started/README.md) guide to learn more about how to extend the functionality with Plugins. ## Documentation -- [FAQs](docs/FAQ.md) - [Getting Started](docs/getting-started/README.md) +- [Create a Backstage App](docs/create-an-app.md) - [Architecture](docs/architecture-terminology.md) - [API references](docs/reference/README.md) - [Designing for Backstage](docs/design.md) @@ -95,6 +97,10 @@ For more complex development environment configuration, see the Or, if you are an open source developer and are interested in joining our team, please reach out to [foss-opportunities@spotify.com ](mailto:foss-opportunities@spotify.com) +## Contributing + +We would love your help in building Backstage! See [CONTRIBUTING](CONTRIBUTING.md) for more information. + ## License Copyright 2020 Spotify AB. diff --git a/docs/getting-started/create-an-app.md b/docs/create-an-app.md similarity index 92% rename from docs/getting-started/create-an-app.md rename to docs/create-an-app.md index 703d1d59a5..8c8050c2ff 100644 --- a/docs/getting-started/create-an-app.md +++ b/docs/create-an-app.md @@ -17,7 +17,7 @@ npx @backstage/cli create-app This will create a new Backstage App inside the current folder. The name of the app-folder is the name that was provided when prompted.

- create app + create app

Inside that directory, it will generate all the files and folder structure needed for you to run your app. @@ -70,7 +70,3 @@ yarn start ``` _When `yarn start` is ready it should open up a browser window displaying your app, if not you can navigate to `http://localhost:3000`._ - -[Next Step - Create a Backstage plugin](create-a-plugin.md) - -[Back to Docs](README.md) diff --git a/docs/getting-started/create-app_output.png b/docs/create-app_output.png similarity index 100% rename from docs/getting-started/create-app_output.png rename to docs/create-app_output.png diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index 163e52b950..064776e712 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -1,9 +1,10 @@ # Getting started with Backstage -Here is a collection of tutorials that will guide you through setting up and extending an instance of Backstage with your own plugins. +## Creating a Plugin + +The value of Backstage grows with every new plugin that gets added. Here is a collection of tutorials that will guide you through setting up and extending an instance of Backstage with your own plugins. - [Development Environment](development-environment.md) -- [Create a Backstage App](create-an-app.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/development-environment.md b/docs/getting-started/development-environment.md index e4fe69af68..7f6e2bcb44 100644 --- a/docs/getting-started/development-environment.md +++ b/docs/getting-started/development-environment.md @@ -34,4 +34,6 @@ Then open http://localhost/ on your browser. > See [package.json](/package.json) for other yarn commands/options. +[Next Step - Create a Backstage plugin](create-a-plugin.md) + [Back to Docs](README.md)