diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md index 972dbfe644..0468ed4378 100644 --- a/docs/getting-started/configuration.md +++ b/docs/getting-started/configuration.md @@ -1,5 +1,5 @@ --- -id: index +id: configuration title: Getting Started, configuring Backstage description: Getting started with your initial Backstage configuration --- @@ -19,7 +19,8 @@ At the end of this tutorial, you can expect: - Access to a Linux-based operating system, such as Linux, MacOS or [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/) -- An account with elevated rights to install prerequisites +- An account with elevated rights to install prerequisites on your operating + system - If the database is not hosted on the same server as the Backstage app, the PostgreSQL port needs to be accessible (the default is 5432 or 5433) @@ -137,16 +138,17 @@ frontend, in our tutorial it would be `http://127.0.0.1:3000`. The likely be `http://127.0.0.1:7007/api/auth/github/handler/frame`.

- Screenshot of the GitHub OAuth creation page + Screenshot of the GitHub OAuth creation page

-Take note of the `Client ID` and the `Client Secret`. Open 'app-config.yaml', +Take note of the `Client ID` and the `Client Secret`. Open `app-config.yaml`, and add your `clientId` and `clientSecret` to this file. It should end up looking like this: ``` auth: # see https://backstage.io/docs/auth/ to learn about auth providers + environment: development providers: github: development: @@ -213,7 +215,7 @@ days for expiration. If you have a hard time picking a number, we suggest to go for 7 days, it's a lucky number.

- Screenshot of the GitHub OAuth creation page + Screenshot of the GitHub OAuth creation page

Set the scope to your likings. For this tutorial, selecting "repo" should be @@ -238,37 +240,39 @@ Some helpful links, for if you want to learn more about: ### Explore what we've done so far +## Login to Backstage and check profile + Open your Backstage frontend. You should see your login screen if you're not logged in yet. As soon as you've logged in, go to Settings, you'll see your -profile. Hopefully You'll recognize the profile picture and name on your screen, +profile. Hopefully you'll recognize the profile picture and name on your screen, otherwise something went terribly wrong. -Register an existing component +## Register an existing component - Register a new component, by going to `create` and choose `Register existing component`

- Software template main screen, with a blue button to add an existing component + Software template main screen, with a blue button to add an existing component

- As URL use `https://github.com/backstage/demo/blob/master/catalog-info.yaml`. - This is used by our demo site. + This is used by our [demo site](https://demo.backstage.io).

- Register a new component wizard, asking for an URL to the existing component YAML file + Register a new component wizard, asking for an URL to the existing component YAML file

- Hit `Analyze` and review the changes. Apply them if correct

- Register a new component wizard, showing the metadata for the component YAML we use in this tutorial + Register a new component wizard, showing the metadata for the component YAML we use in this tutorial

- You should receive a message that your entities have been added. - If you go back to `Home`, you should be able to find `demo`. You should be able to click it and see the details -Create a new component using a software template +## Create a new component using a software template - Go to `create` and choose to create a website with the `React SSR Template` - Type in a name, let's use `tutorial` @@ -276,15 +280,15 @@ Create a new component using a software template step

- Software template deployment input screen asking for a name, the group owning this and a description + Software template deployment input screen asking for a name, the group owning this, and a description

-- For the location, we're going to use the default GitHub location. +- For the location, we're going to use the default - As owner, type your GitHub username - For the repository name, type `tutorial`. Go to the next step

- Software template deployment input screen asking for the github username and name of the new repo to create + Software template deployment input screen asking for the github username, and name of the new repo to create

- Review the details of this new service, and press `Create` if you want to diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 02e2e4d51d..d05adbb0a0 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -58,7 +58,7 @@ The wizard will ask you SQLite option.

- Screenshot of the wizard asking for a name for the app, and a selection menu for the database. + Screenshot of the wizard asking for a name for the app, and a selection menu for the database.

### Run the Backstage app @@ -73,7 +73,7 @@ yarn dev ```

- Screenshot of the command output, with the message web pack compiled successfully. + Screenshot of the command output, with the message web pack compiled successfully.

It might take a little while, but as soon as the message @@ -87,12 +87,9 @@ carry on with the database steps. Screenshot of the Backstage portal.

-The most common next steps are to move to a persistent database, configure -authentication, and add a plugin: - -- [Switching from SQLite to PostgresQL](https://backstage.io/docs/tutorials/switching-sqlite-postgres) -- [Setting up Authentication](https://backstage.io/docs/auth/) -- [Adding a plugin](https://backstage.io/docs/getting-started/configure-app-with-plugins) +In the next part of this tutorial, you'll learn how to change to a persistent +database, configure authentication, and add your first integration. Continue +with [getting started: Configuring Backstage](configuration.md). Congratulations! That should be it. Let us know how it went: [on discord](https://discord.gg/EBHEGzX), file issues for any diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 89eb282d14..d41aab4f7a 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -14,6 +14,7 @@ ], "Getting Started": [ "getting-started/index", + "getting-started/configuration", "getting-started/create-an-app", "getting-started/running-backstage-locally", { diff --git a/mkdocs.yml b/mkdocs.yml index 2eed377819..625236f737 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -64,6 +64,7 @@ nav: - Backstage Search: - Overview: 'features/search/README.md' - Getting Started: 'features/search/getting-started.md' + - Getting Started, configuring Backstage: 'features/search/configuration.md' - Concepts: 'features/search/concepts.md' - Search Architecture: 'features/search/architecture.md' - Search Engines: 'features/search/search-engines.md'