14 Commits

Author SHA1 Message Date
ryoku4 247ec64ba5 docs: correct "Github" to "GitHub" in multiple documentation files
Signed-off-by: ryoku4 <122875619+ryoku4@users.noreply.github.com>
2026-05-23 00:23:27 +09:00
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
Patrik Oldsberg 8632502abe Merge pull request #33436 from jonkoops/remove-legacy-proxy-docs
docs: remove legacy corporate proxy documentation
2026-04-07 16:30:05 +02:00
Fredrik Adelöw bb7768ba06 docs: fix broken links and anchors across documentation
Fix ~30 broken links and anchors across the documentation site, including
incorrect relative paths, mismatched anchor names, zero-width characters
in URLs, and references to renamed or removed headings.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Fredrik Adelöw <freben@spotify.com>
2026-03-31 18:43:40 +02:00
Patrik Oldsberg 0f8b40ddc5 docs: address copilot review comments
Add installation example for extraIcons in the customize-theme guide
and fix "productional code" typo in quickstart-app-plugin--old.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-30 12:57:47 +02:00
Patrik Oldsberg 15ab64be96 docs: fix relative link depth in customize-theme guide
The previous fix overshot the directory traversal — three levels up
escapes the docs root. Use two levels (`../../`) to correctly reach the
frontend-system migration guide from golden-path/create-app/.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 22:49:58 +02:00
Patrik Oldsberg dce631e6f7 docs: fix broken relative link in customize-theme guide
Fix the relative path to the sidebar customization section in the
migration guide, which was missing two levels of directory traversal.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 22:39:53 +02:00
Patrik Oldsberg 7c1b319e74 docs: migrate getting-started docs to new frontend system
Migrate four documentation pages to use the new frontend system as the
primary content, moving the old frontend system instructions to --old
files following the established convention:

- configure-app-with-plugins: rewrite for auto-discovered plugins
- customize-theme: rewrite for ThemeBlueprint/extension-based theming
- enable-public-entry: make new frontend system the primary content
- quickstart-app-plugin: remove manual sidebar wiring instructions

Each main file gets an info banner linking to the --old variant, and
each --old file gets a banner linking back to the current guide.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-29 21:35:17 +02:00
Jon Koops 980b7f5632 docs: remove legacy corporate proxy documentation
All Node.js versions in Backstage's support matrix (v22 and v24 LTS)
include built-in proxy support via NODE_USE_ENV_PROXY, making the
legacy global-agent/undici workarounds unnecessary. Remove the legacy
proxy guide from contrib/ and all references to the legacy approach
across the docs.

Signed-off-by: Jon Koops <jonkoops@gmail.com>
2026-03-19 17:17:17 +01:00
Patrik Oldsberg 73deff4947 Merge pull request #33316 from chanchalkhatri19/add-golden-path-descriptions
docs: add missing description frontmatter to golden-path docs
2026-03-17 22:03:49 +01:00
Jon Koops 956133bf45 docs: recommend Node.js built-in proxy support for corporate proxies (#33006)
Node.js 22.21.0+ natively supports HTTP_PROXY, HTTPS_PROXY, and
NO_PROXY environment variables via NODE_USE_ENV_PROXY, eliminating the
need for undici and global-agent workarounds. This also works with
node-fetch and cross-fetch since they delegate to node:http/node:https
without overriding the HTTP agent.

Add a new corporate proxy tutorial under docs/ with the recommended
approach and update the legacy guide in contrib/ to point to it.
Update proxy references in the deployment, keeping-backstage-updated,
and TechDocs CLI docs to mention NODE_USE_ENV_PROXY.

Signed-off-by: Jon Koops <jonkoops@gmail.com>
2026-03-17 13:13:00 -04:00
chanchalkhatri19 21608833fa docs: add missing description frontmatter to golden-path docs
Signed-off-by: chanchalkhatri19 <chanchal.khatri01@infosys.com>
2026-03-12 12:44:43 +00:00
Aramis Sennyey 9f298e81ee docs: start creating a golden path (#30925)
* docs: starting to fill out the plugin golden path

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* another bit of work

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* create-app docs

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* Apply suggestions from code review

Co-authored-by: Peter Macdonald <peterm4c@pm.me>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>

* address PR feedback

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* update to rspack

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* fix lint errors

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* add flag for golden paths

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

---------

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
Co-authored-by: Peter Macdonald <peterm4c@pm.me>
2025-10-22 12:02:43 -04:00
aramissennyeydd ed80ef94b3 feat(docs): start preparing a golden path
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
2025-02-14 14:24:13 -05:00