Clarify creating a new plugin as the next step (#575)

* Move create-app docs out from getting started

* Add contributing to readme.md
This commit is contained in:
Marcus Eide
2020-04-17 11:44:36 +02:00
committed by GitHub
parent eb76a4d05a
commit 23802d6c58
5 changed files with 19 additions and 14 deletions
+13 -7
View File
@@ -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.