Merge pull request #262 from spotify/alund/docs

Put getting started back in README
2020-03-16 09:24:01 +01:00
parent 2da3b853e6 a7b6e75f39
commit 4dda4695fb
5 changed files with 52 additions and 48 deletions
@@ -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

@@ -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)
@@ -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)
@@ -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)
@@ -15,9 +15,15 @@
 */

 import React, { FC } from 'react';
-import Link from '@material-ui/core/Link';
 import { Link as RouterLink } from 'react-router-dom';
-import { Typography, Grid } from '@material-ui/core';
+import {
+  Typography,
+  Grid,
+  List,
+  ListItem,
+  ListItemText,
+  Link,
+} from '@material-ui/core';
 import Timer from '../Timer';
 import {
  Content,
@@ -28,8 +34,6 @@ import {
  ContentHeader,
  SupportButton,
 } from '@spotify-backstage/core';
-import List from '@material-ui/core/List';
-import ListItem from '@material-ui/core/ListItem';

 const WelcomePage: FC<{}> = () => {
  const profile = { givenName: '' };
@@ -64,20 +68,26 @@ const WelcomePage: FC<{}> = () => {
                Backstage is put together from three base concepts: the core,
                the app and the plugins.
              </Typography>
-              <ul>
-                <li>The core is responsible for base functionality.</li>
-                <li>The app provides the base UI and connects the plugins.</li>
-                <li>
-                  The plugins make Backstage useful for the end users with
-                  specific views and functionality.
-                </li>
-              </ul>
+              <List>
+                <ListItem>
+                  <ListItemText primary="The core is responsible for base functionality." />
+                </ListItem>
+                <ListItem>
+                  <ListItemText primary="The app provides the base UI and connects the plugins." />
+                </ListItem>
+                <ListItem>
+                  <ListItemText
+                    primary="The plugins make Backstage useful for the end users with
+                  specific views and functionality."
+                  />
+                </ListItem>
+              </List>
              <Typography variant="h6" gutterBottom>
                Try It Out
              </Typography>
              <Typography variant="body1" paragraph>
                We suggest you either check out the documentation for{' '}
-                <Link href="https://github.com/spotify/backstage#plugins">
+                <Link href="https://github.com/spotify/backstage/blob/master/docs/getting-started/create-a-plugin.md">
                  creating a plugin
                </Link>{' '}
                or have a look in the code for the{' '}
@@ -96,7 +106,7 @@ const WelcomePage: FC<{}> = () => {
                  <Link href="https://backstage.io">backstage.io</Link>
                </ListItem>
                <ListItem>
-                  <Link href="https://github.com/spotify/backstage#plugins">
+                  <Link href="https://github.com/spotify/backstage/blob/master/docs/getting-started/create-a-plugin.md">
                    Create a plugin
                  </Link>
                </ListItem>