Merge pull request #17339 from awanlin/topic/remove-running-backstage-locally

Removed Running Backstage Locally documentation page
2023-04-21 21:46:40 +02:00
parent 075a9bbcf1 3d809a66bf
commit e4e9caaa42
8 changed files with 11 additions and 131 deletions
@@ -173,11 +173,6 @@ export default async function createPlugin(
 }
 ```

-## Running Backstage locally
-
-Start the frontend and the backend app by
-[running Backstage locally](../../getting-started/running-backstage-locally.md).
-
 ## Configuration

 After installing the plugins in the code, you'll need to then
@@ -284,14 +284,6 @@ Note: We recommend Python version 3.7 or higher.
 > Python packages. The order is important to make sure we get correct version of
 > some of the dependencies.

-## Running Backstage locally
-
-Start the frontend and the backend app by
-[running Backstage locally](../../getting-started/running-backstage-locally.md).
-
-Open your browser at [http://localhost:3000/docs/](http://localhost:3000/docs/)
-to see all your documentation sites.
-
 ## Additional reading

 - [Creating and publishing your docs](creating-and-publishing.md)
@@ -10,8 +10,8 @@ App.
 A Backstage App is a monorepo setup with `lerna` that includes everything you
 need to run Backstage in your own environment.

-If you intend to develop a plugin or contribute to the Backstage project, you
-may want to [Run Backstage Locally](./running-backstage-locally.md) instead.
+If you intend to contribute a plugin, new feature, or bug fix to the Backstage project, you
+may want to read the [Contributors](./contributors.md) guide instead.

 ## Create an app

@@ -28,7 +28,7 @@ don't worry about the choice, it's easy to change later! Here is a
 The easiest way to run the create app package is with `npx`:

 ```bash
-npx @backstage/create-app
+npx @backstage/create-app@latest
 ```

 This will create a new Backstage App inside the current folder. The name of the
@@ -106,9 +106,8 @@ example [here](https://www.python.org/downloads/) to install it.

 #### Could not execute command yarn install

-Install yarn on your system with `npm install --global yarn` or for more details
-refer to the
-[prerequisites](https://backstage.io/docs/getting-started/running-backstage-locally#prerequisites)
+Install Yarn on your system with `npm install --global yarn` or for more details
+refer to the [prerequisites](index.md#prerequisites).

 ## Run the app

@@ -14,10 +14,8 @@ This guide assumes a basic understanding of working on a Linux based operating
 system using tools like apt-get, npm, yarn, curl. Docker knowledge is also
 helpful for making the best use of your Backstage installation.

-If you are planning to contribute plugins or the project in general, we advise
-you to use the
-[Getting Started for Contributors](https://backstage.io/docs/getting-started/running-backstage-locally)
-guide to do a repository-based installation.
+If you are planning to contribute plugins or to the project in general, we advise
+you to use the [Contributors](contributors.md) guide to do a repository-based installation.

 ### Prerequisites

@@ -1,106 +0,0 @@
---
-id: running-backstage-locally
-title: Running Backstage Locally
-description: Documentation on How to run Backstage Locally
---
-
-To develop a plugin or contribute to the Backstage project, we recommend cloning
-the Backstage repository and running locally in development mode. If you are not
-trying to contribute, follow the instructions to
-[Create an App](./create-an-app.md) instead.
-
-## Prerequisites
-
- Node.js
-
-First make sure you are using Node.js with an [Active LTS Release](https://nodejs.org/en/about/releases/).
-This is made easy with a version manager such as
-[nvm](https://github.com/nvm-sh/nvm) which allows for version switching.
-
-```bash
-# Installing current LTS release
-nvm install --lts
-> Installing latest LTS version.
-> Downloading and installing node v16.16.0...
-> Now using node v16.16.0 (npm v8.11.0)
-
-# Checking your version
-node --version
-> v16.16.0
-```
-
- Yarn
-
-Please refer to the
-[installation instructions for Yarn](https://classic.yarnpkg.com/en/docs/install/).
-
- Docker
-
-We use Docker for few of our core features. So, you will need Docker installed
-locally to use features like Software Templates and TechDocs. Please refer to
-the
-[installation instructions for Docker](https://docs.docker.com/engine/install/).
-
-## Clone and Install
-
-To get up and running with a local Backstage to evaluate it, let's clone it off
-of GitHub and run an initial install.
-
-```bash
-# Start from your local development folder
-git clone --depth 1 https://github.com/backstage/backstage.git
-cd backstage
-
-# Install our dependencies
-yarn install
-```
-
-Phew! Now you have a local repository that's ready to run and to add any open
-source contributions into.
-
-We are now going to launch two things: an example Backstage frontend app, and an
-example Backstage backend that the frontend talks to. These can both be launched
-through the following command:
-
-```bash
-# From your Backstage root directory, launches both the frontend and backend
-yarn dev
-```
-
-If you prefer to run the frontend and backend separately, you can instead use `yarn start`
-and `yarn start-backend` in two separate terminal windows.
-
-Which ever way you choose, you will now have a backend instance running on port 7007,
-and the frontend running on port 3000. A browser window should also automatically open,
-showing the frontend.
-
-## 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/backstage/backstage/tree/master/plugins/auth-backend#github).
-
---
-
-Congratulations! That should be it. Let us know how it went
-[on discord](https://discord.gg/backstage-687207715902193673), file issues for any
-[feature](https://github.com/backstage/backstage/issues/new?labels=help+wanted&template=feature_template.md)
-or
-[plugin suggestions](https://github.com/backstage/backstage/issues/new?labels=plugin&template=plugin_template.md&title=%5BPlugin%5D+THE+PLUGIN+NAME),
-or
-[bugs](https://github.com/backstage/backstage/issues/new?labels=bug&template=bug_template.md)
-you have, and feel free to
-[contribute](https://github.com/backstage/backstage/blob/master/CONTRIBUTING.md)!
-
-## Creating a Plugin
-
-The value of Backstage grows with every new plugin that gets added. Here is a
-collection of tutorials that will guide you through setting up and extending an
-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)
@@ -125,6 +125,10 @@ module.exports = {
            from: '/docs/features/search/search-overview',
            to: '/docs/features/search/',
          },
+          {
+            from: '/docs/getting-started/running-backstage-locally',
+            to: '/docs/getting-started/',
+          },
        ],
      },
    ],
@@ -35,7 +35,6 @@
      "getting-started/index",
      "getting-started/configuration",
      "getting-started/create-an-app",
-      "getting-started/running-backstage-locally",
      {
        "type": "category",
        "label": "App configuration",
@@ -23,7 +23,6 @@ nav:
  - Getting Started:
      - Getting Started: 'getting-started/index.md'
      - Create an App: 'getting-started/create-an-app.md'
-      - Running Backstage locally: 'getting-started/running-backstage-locally.md'
      - App configuration:
          - Configuring App with plugins: 'getting-started/configure-app-with-plugins.md'
          - Customize the look-and-feel of your App: 'getting-started/app-custom-theme.md'