From 687ddc49d7c635e183905b52536f460e4ff76a43 Mon Sep 17 00:00:00 2001 From: blam Date: Fri, 12 Feb 2021 23:50:03 +0100 Subject: [PATCH] chore: reworking the title of the docs to avoid confusion --- CONTRIBUTING.md | 2 +- .../{development-environment.md => contributors.md} | 13 +++++++++---- 2 files changed, 10 insertions(+), 5 deletions(-) rename docs/getting-started/{development-environment.md => contributors.md} (96%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb6b524c14..ddc5449cd8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,7 +66,7 @@ Have you started using Backstage? Adding your company to [ADOPTERS](ADOPTERS.md) So...feel ready to jump in? Let's do this. 👏🏻💯 -Start by reading our [Development Environment](https://backstage.io/docs/getting-started/development-environment) page to get yourself setup with a fresh copy of Backstage ready for your contributions. If you need help, just jump into our [Discord chatroom](https://discord.gg/MUpMjP2). +Start by reading our [Getting Started for Contributors](https://backstage.io/docs/getting-started/contributors) page to get yourself setup with a fresh copy of Backstage ready for your contributions. If you need help, just jump into our [Discord chatroom](https://discord.gg/MUpMjP2). ## Coding Guidelines diff --git a/docs/getting-started/development-environment.md b/docs/getting-started/contributors.md similarity index 96% rename from docs/getting-started/development-environment.md rename to docs/getting-started/contributors.md index cbbb2798f4..e7e1986170 100644 --- a/docs/getting-started/development-environment.md +++ b/docs/getting-started/contributors.md @@ -1,6 +1,6 @@ --- -id: development-environment -title: Development Environment +id: contributors +title: Contributors # prettier-ignore description: Documentation on how to get set up for doing development on the Backstage repository --- @@ -11,7 +11,12 @@ repository. ## Cloning the Repository Ok. So you're gonna want some code right? Go ahead and fork the repository into -your own GitHub account and clone that code to your local machine! +your own GitHub account and clone that code to your local machine or you can +grab the one for the origin like so: + +```bash +git clone git@github.com/backstage/backstage --depth 1 +``` After you have cloned the Backstage repository, you should run the following commands once to set things up for development: @@ -43,7 +48,7 @@ setting an environment variable `PORT` on your local machine. e.g. Once successfully started, you should see the following message in your terminal window: -``` +```sh $ concurrently "yarn start" "yarn start-backend" $ yarn workspace example-app start $ yarn workspace example-backend start