Replace graphic showing output of creating the app with text block for standalone installation doc (#33009)
* change background to transparent Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Updated graphic to correct transparency background Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fix several transparency glitches Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fix a couple transparency glitches in letters Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fix transparency errors Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fix transparency error Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Replaced image of create app output with a text block Added detailed output for app creation process and running instructions. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Simplify create an app output in documentation Removed multiple file copying and templating steps from the getting started guide. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Revise console output in getting started guide Updated installation instructions for Backstage application to include console as the language for the code blocks Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Delete docs/assets/getting-started/create-app-output.png Graphic has been replaced with a code block. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update docs/getting-started/index.md Changed output of creating backstage app to remove the 7.4 version with just <version> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update docs/getting-started/index.md Fixed indentation in console output Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fix formatting in getting started installation steps Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Change app creation console output from graphic to text block Added console output example for app creation process. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Remove emoji from installation success message Removed emoji from success message in installation steps. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update success message formatting in npx-create-app.md Removed emoji from success message in npx-create-app.md. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fix code block formatting in getting started guide Corrected formatting of code block for installation command. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Improve console output formatting in installation guide Updated console output examples and formatting in the getting started guide. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update npx-create-app.md with ellipsis Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update getting started index with ellipsis Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update getting started index with final steps Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update npx-create-app.md for clarity Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update docs/getting-started/index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Try to fix Prettier errors Try to fix Prettier errors in getting started index.md file = creating a standalone application. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fix Prettier errors in npx-create-app.md Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update docs/getting-started/index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fix code block formatting in getting started guide Correct formatting for code blocks in installation instructions. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fix formatting in installation instructions to satisfy prettier Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update docs/getting-started/index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fixed indentation of create app output to match getting started Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update docs/getting-started/index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fix formatting in getting started installation command Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Fix Prettier errors Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> * Update docs/getting-started/index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> --------- Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
milliehartnt123
Binary file not shown.
|
Before Width: | Height: | Size: 122 KiB |
@@ -101,21 +101,46 @@ To create the application:
|
||||
|
||||
1. Type the following command to install the Backstage application.
|
||||
|
||||
```bash
|
||||
npx @backstage/create-app@latest
|
||||
```
|
||||
```bash
|
||||
npx @backstage/create-app@latest
|
||||
```
|
||||
|
||||
2. If this is the first time that you are installing a Backstage application on this device, the following question is displayed. Enter `y` and select `Enter` to proceed with the installation.
|
||||
|
||||
```
|
||||
Need to install the following packages:
|
||||
@backstage/create-app@0.7.4
|
||||
ok to proceed? (y)
|
||||
```
|
||||
```console
|
||||
Need to install the following packages:
|
||||
@backstage/create-app@<version>
|
||||
ok to proceed? (y)
|
||||
```
|
||||
|
||||
3. Enter the name for your application and select `Enter`. This is the root directory of your application. In this example, the name is set to `my-backstage-app`.
|
||||
|
||||
|
||||
```console
|
||||
? Enter a name for the app [required] my-backstage-app
|
||||
|
||||
Creating the app...
|
||||
|
||||
Checking if the directory is available:
|
||||
|
||||
checking my-backstage-app ✔
|
||||
|
||||
Creating a temporary app directory:
|
||||
|
||||
Preparing files:
|
||||
copying .dockerignore ✔
|
||||
copying .eslintignore ✔
|
||||
templating .eslintrc.js.hbs ✔
|
||||
...
|
||||
Moving to final location:
|
||||
moving my-backstage-app ✔
|
||||
fetching yarn.lock seed ✔
|
||||
|
||||
Installing dependencies:
|
||||
executing yarn install ✔
|
||||
executing yarn tsc ✔
|
||||
|
||||
Successfully created my-backstage-app
|
||||
```
|
||||
|
||||
Your Backstage app is fully installed and ready to be run! Now that the installation is complete, you can go to the application directory and start the app using the `yarn start` command. The `yarn start` command will run both the frontend and backend as separate processes (named `[0]` and `[1]`) in the same window.
|
||||
|
||||
|
||||
@@ -56,7 +56,33 @@ The wizard for this command will ask what name you want to have for your new app
|
||||
|
||||
When you run the command, you'll see an output like this.
|
||||
|
||||
|
||||
```console
|
||||
|
||||
? Enter a name for the app [required] my-backstage-app
|
||||
|
||||
Creating the app...
|
||||
|
||||
Checking if the directory is available:
|
||||
|
||||
checking my-backstage-app ✔
|
||||
|
||||
Creating a temporary app directory:
|
||||
|
||||
Preparing files:
|
||||
copying .dockerignore ✔
|
||||
copying .eslintignore ✔
|
||||
templating .eslintrc.js.hbs ✔
|
||||
...
|
||||
Moving to final location:
|
||||
moving my-backstage-app ✔
|
||||
fetching yarn.lock seed ✔
|
||||
|
||||
Installing dependencies:
|
||||
executing yarn install ✔
|
||||
executing yarn tsc ✔
|
||||
|
||||
Successfully created my-backstage-app
|
||||
```
|
||||
|
||||
And when it finishes, you'll have a working Backstage app (with example data)!
|
||||
|
||||
|
||||
Reference in New Issue
Block a user