78 Commits

Author SHA1 Message Date
milliehartnt123 35fb74c310 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>
2026-04-16 15:51:55 -04:00
milliehartnt123 e46ec22005 Merge branch 'backstage:master' into milliehartnt123-create-ui-doc 2026-02-17 09:23:28 -05:00
milliehartnt123 4971828eeb Rename 'Searching the Catalog' to 'Filtering the Catalog'
Also changed the name of the file for the link from search-catalog.md to filter-catalog.md

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2026-02-12 09:15:48 -05:00
Patrik Oldsberg a21f50fc57 docs: apply minor fixes from feedback
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-01-30 11:36:09 +01:00
milliehartnt123 9ef38f9745 Merge branch 'backstage:master' into milliehartnt123-create-ui-doc 2026-01-20 12:27:24 -05:00
Andre Wanlin 5af1d3d113 Updated Prerequisites Node version
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-01-05 12:31:54 -06:00
milliehartnt123 98f87340ce Fix links formatting in getting-started index
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2026-01-05 13:28:09 -05:00
milliehartnt123 8c9444160d Add new links to developer documentation
Added links for the new catalog and component pages to the what to next as a developer section at the bottom of the page.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2026-01-05 13:25:44 -05:00
milliehartnt123 46bfd1a485 Update create an app for feature issue 21913 (#31366)
* Update index.md rewritten as task-based steps

Page has been rewritten and images have been updated/replaced.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Updated create-app-output and portal graphics

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Updated name of backstage app in graphic

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update index.md to add guest user login screen and graphic

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Add graphic for guest user login screen to app

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update index.md

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update index.md rearranged guest login section

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update index.md fixed some indenting issues

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update index.md fix prettier errors

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update index.md rearranged admin links at bottom of page

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update index.md fix prettier errors

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update index.md changed title and added prerequisites

Made the isolated-vm module installed by everyone. Changed the title and sidebar_label. Added disc space size requirement and a note to the Linux requirement. 

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update index.md Add minimum of 4 GB memory as placeholder.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update index.md fix prettier errors

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update index.md added additional text and removed a graphic

Updated tip from 'webpack compiled successfully' to "Rspack compiled successfully'

Added selected output from 'yarn start' command to explain the sequence of calls that are being done when starting up the frontend and backend.

Removed graphic that showed 'webpack compiled successfully'.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Fix formatting issues in getting-started documentation

Fixed prettier errors

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update system requirements for Backstage application

Updated minimum memory and disk space requirements.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update docs/getting-started/index.md

Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>

* Fix spelling error in getting started documentation

Corrected the spelling of 'initialized' in the documentation.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Simplify frontend startup instructions

Removed redundant information about waiting for the frontend to start.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

---------

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
Co-authored-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
2025-12-30 22:22:47 +00:00
Charles de Dreuille 8b25afdf12 Fix link error
Signed-off-by: Charles de Dreuille <charles.dedreuille@gmail.com>
2025-09-11 11:32:32 +01:00
JeevaRamanathan 4b77a0ad1d Merge branch 'master' into patch-3
Signed-off-by: JeevaRamanathan <64531160+JeevaRamanathan@users.noreply.github.com>
2025-09-09 17:22:23 +05:30
Andre Wanlin 1d15f6b01b Removed references to Lerna as it's not used
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2025-09-09 11:37:03 +02:00
JeevaRamanathan aca3cab2cc Improve readability in getting-started documentation
Signed-off-by: JeevaRamanathan <64531160+JeevaRamanathan@users.noreply.github.com>
2025-09-07 19:06:05 +05:30
Patrik Oldsberg e655f626ad update existing references to yarn dev to use yarn start instead
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2025-04-08 13:14:46 +02:00
immanchand f258ec1b12 Update index.md
Fixed grammatical errors

Signed-off-by: immanchand <53471578+immanchand@users.noreply.github.com>
2024-12-31 00:17:43 -08:00
Johan Haals 24745ae545 Merge pull request #27672 from Parsifal-M/docs/getting-started-21828
[DOCS] Restructure the Getting Started Section
2024-11-19 11:48:07 +01:00
Andre Wanlin 9a4e0bd9e6 Updated Getting Started Node LTS Link
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-11-18 15:29:43 -06:00
Peter Macdonald c7856c4633 pre-requisites too over the top, pepper the recommended key concepts where they are likely used
Signed-off-by: Peter Macdonald <macdonald.peter90@gmail.com>
2024-11-15 17:20:09 +01:00
Peter Macdonald 0afc355fac look into reorganising the Getting Started section to meet the CNCF recommendations
Signed-off-by: Peter Macdonald <macdonald.peter90@gmail.com>
2024-11-15 13:20:36 +01:00
Patrik Oldsberg 1c29b31dd3 docs/getting-started: reorder next steps a bit
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-11-08 16:56:40 +01:00
Andre Wanlin ba1ed8db06 Updated Yarn & Node Prerequisites
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-11-01 17:54:28 -05:00
Łukasz Jernaś 326faeddae fix(docs): Fixed various letter casing and script errors
Signed-off-by: Łukasz Jernaś <lukasz.jernas@allegro.com>
2024-09-09 10:36:59 +02:00
Piotr Piątkiewicz b6dcc1ce1a Typo in docs/getting-started
Signed-off-by: Piotr Piątkiewicz <piatkiewicz.piotr@gmail.com>
2024-09-06 16:43:21 +02:00
Andre Wanlin feb0734e02 Updated intro title
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2024-07-28 15:39:40 -05:00
Fredrik Adelöw 4a6741b1ba docs too
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-04-23 17:45:35 +02:00
Aramis 21684fe210 apply suggestions from code review
Signed-off-by: Aramis <sennyeyaramis@gmail.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2024-02-17 16:19:02 -05:00
Aramis a33bd1f7a8 docs: start adding user roles to getting started documentation
Following CNCF guidelines for improved Backstage documentation.

Signed-off-by: Aramis <sennyeyaramis@gmail.com>
2024-02-17 16:19:02 -05:00
Andre Wanlin 6f68649e47 Getting started corrections
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2023-12-15 11:54:32 -06:00
Andre Wanlin 4f07583ea6 Corrections to get build to pass
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-09-08 14:24:48 -05:00
blam 0a9c34febf docs: add a note about isolated vm
Signed-off-by: blam <ben@blam.sh>
2023-06-27 11:24:42 +02:00
Fredrik Adelöw e22db10765 prettier
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-05-11 15:20:05 +02:00
mipolak d0ee181350 linux prerequisites updated according the advice by freben.
Signed-off-by: mipolak <misopo@gmail.com>
2023-05-11 15:03:17 +02:00
mipolak bd5b60b80f added prerequisites
added prerequisites make and build-essential

Signed-off-by: mipolak <40818407+mipolak@users.noreply.github.com>
2023-05-05 10:35:33 +02:00
Andre Wanlin 3d809a66bf Changes based on feedback
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-04-14 12:39:23 -05:00
Andre Wanlin 90b157c999 Removed running-backstage-locally.md
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-04-12 14:31:26 -05:00
blam f79bafb844 chore: fix doscird links
Signed-off-by: blam <ben@blam.sh>
2023-02-23 10:37:57 +01:00
Johan Haals 7a23cdfa59 Update image links to use markdown syntax
Co-authored-by: Ben Lambert <ben@blam.sh>
Co-authored-by: Fredrik Adelöw <freben@users.noreply.github.com>
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2023-02-21 11:43:14 +01:00
Peter Macdonald 368a4d6bdf Udated the getting-started docs only as advised
Signed-off-by: Peter Macdonald <macdonald.peter90@gmail.com>
2022-12-27 12:14:14 +01:00
Patrik Oldsberg a531879958 docs/getting-started: clarify yarn version
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-11-17 14:03:01 +01:00
Andre Wanlin e65f18e0a2 Removed database step from docs
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-10-12 15:35:03 -05:00
Leena fc4d638296 @backstage/docs: fix dead link Active LTS Releases
was `https://nodejs.org/en/about/releases/`
now `https://nodejs.org/en/blog/release/`

Signed-off-by: Leena <19555355+sploschee@users.noreply.github.com>
2022-09-17 19:20:26 +01:00
Erik Price f61d7714aa Fix typo
Replace "Linux-based" with "Unix-based".

Signed-off-by: Erik Price <mail@erikprice.com>
2022-06-24 11:56:41 -04:00
Paweł Wamej c7a3ae7692 fix missing bullet point
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-02-16 19:46:01 +01:00
Paweł Wamej c553646511 keep format consistent
Co-authored-by: Andrew Basson <andrew.basson@gmail.com>
Signed-off-by: Pawel Wamej <pwamej@gmail.com>
2022-02-15 07:09:39 +01:00
Pawel Wamej 90f3729b9d remove node version from installation instructions
It's outdated (v16 is the active LTS curently) and IMO it's better to link to the Node docs rather than update it every 6 months.

Signed-off-by: Pawel Wamej <pwamej@gmail.com>
2022-02-12 19:06:19 +01:00
Suzanne Daniels 20b96aa6db Prettier ^^
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-12-21 20:27:25 +01:00
Suzanne Daniels f2bbca8dcf Linking to part two, fixing spelling & script colorizing
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-12-21 09:59:31 +01:00
Suzanne Daniels 32d733fbf1 removing modifications
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-12-07 17:17:35 +01:00
Suzanne Daniels 981f82983b Processing review comments - links, img, clarify
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-12-06 13:26:05 +01:00
Suzanne Daniels 57abdfc703 Applying @adamdmharvey suggestions from #8275
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-11-29 15:53:41 +01:00