From fe64f992f6b00237c6d519eefdf72703dcf3aca4 Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Sat, 12 Sep 2020 23:50:59 +0200 Subject: [PATCH 1/3] Add Authentication section in Getting Started Closes https://github.com/spotify/backstage/issues/2415 --- docs/getting-started/running-backstage-locally.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/getting-started/running-backstage-locally.md b/docs/getting-started/running-backstage-locally.md index 8b19910c8f..63caf292f5 100644 --- a/docs/getting-started/running-backstage-locally.md +++ b/docs/getting-started/running-backstage-locally.md @@ -58,6 +58,17 @@ yarn start That starts up the frontend on port 3000, and should automatically open a browser window showing it. +## Authentication + +When Backstage starts, you can choose to enter as a Guest user and start +exploring. + +But you can also set up any of the available authentication methods. The easiest +option will be GitHub. To setup GitHub authentication in Backstage, see +[these instructions](https://github.com/spotify/backstage/tree/master/plugins/auth-backend#github). + +--- + Congratulations! That should be it. Let us know how it went [on discord](https://discord.gg/EBHEGzX), file issues for any [feature](https://github.com/spotify/backstage/issues/new?labels=help+wanted&template=feature_template.md) From 841dc867eed94d75065bdf57fe268017488c79af Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Sat, 12 Sep 2020 23:51:29 +0200 Subject: [PATCH 2/3] Docs: Remove unnecessary back to docs link --- docs/getting-started/running-backstage-locally.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/getting-started/running-backstage-locally.md b/docs/getting-started/running-backstage-locally.md index 63caf292f5..7df6325452 100644 --- a/docs/getting-started/running-backstage-locally.md +++ b/docs/getting-started/running-backstage-locally.md @@ -89,5 +89,3 @@ instance of Backstage with your own plugins. - [Create a Backstage Plugin](../plugins/create-a-plugin.md) - [Structure of a Plugin](../plugins/structure-of-a-plugin.md) - [Utility APIs](../api/utility-apis.md) - -[Back to Docs](../README.md) From ea4884ed9719573f55de9949c5c8589d27d607c9 Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Sat, 12 Sep 2020 23:52:34 +0200 Subject: [PATCH 3/3] Docs: Link to nvm repository for users to install --- docs/getting-started/running-backstage-locally.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/running-backstage-locally.md b/docs/getting-started/running-backstage-locally.md index 7df6325452..08d2ab385b 100644 --- a/docs/getting-started/running-backstage-locally.md +++ b/docs/getting-started/running-backstage-locally.md @@ -4,8 +4,8 @@ title: Running Backstage Locally --- First make sure you are using NodeJS with an Active LTS Release, currently v12. -This is made easy with a version manager such as nvm which allows for version -switching. +This is made easy with a version manager such as +[nvm](https://github.com/nvm-sh/nvm) which allows for version switching. ```bash # Checking your version