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
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
9718e62c2d
Merge pull request #33667 from backstage/docs-features-new-frontend-migration
...
docs: migrate feature documentation to new frontend system as primary content
2026-04-07 12:01:07 +02:00
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
561f555fb1
docs: address copilot review feedback
...
Fix links in viewing-catalog.md and filter-catalog.md to point to
the new frontend system catalog-customization.md instead of the old
guide. Fix the Kubernetes entity content extension ID to use the
correct `entity-content:kubernetes/kubernetes` format. Wrap raw
extension definitions in `createFrontendModule` in search and
scaffolder docs. Correct TechDocs addon installation instructions
to explicitly install addon modules rather than claiming
auto-discovery.
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
Made-with: Cursor
2026-03-30 12:42:11 +02:00
8ec254cd4b
docs: migrate feature docs to new frontend system as primary content
...
Rewrite documentation for TechDocs, Software Templates, Software Catalog,
Search, and Kubernetes features to use the new frontend system as the
primary installation and configuration instructions. Old frontend system
instructions are moved to separate `--old` suffixed files for pages with
substantial legacy content, or updated inline for pages with minimal
old-system content.
Files migrated:
- techdocs/getting-started.md
- techdocs/how-to-guides.md
- software-templates/writing-custom-step-layouts.md
- software-templates/writing-custom-field-extensions.md
- software-templates/index.md
- software-catalog/catalog-customization.md
- search/getting-started.md
- search/how-to-guides.md
- kubernetes/installation.md
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
Made-with: Cursor
2026-03-29 21:47:46 +02:00
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
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
f4c012dee3
Merge pull request #33064 from awanlin/docs/nfs-getting-started-auth
...
[Docs] NFS - Authentication
2026-03-17 12:35:02 -05:00
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
e189e60cb2
Fixed links
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2026-03-17 11:36:00 -05:00
11e380b83a
Invert based on feedback
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2026-03-17 11:15:41 -05:00
b7f37a60ad
Fixed CI and addressed comments
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2026-03-17 10:30:59 -05:00
9a82ed5269
[Docs] NFS - Authentication
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2026-03-17 10:30:58 -05:00
1decc6f994
Split legacy homepage getting started docs
...
Move the old frontend system homepage guide to its own companion page and add a banner to the main homepage guide that directs legacy users to the split-out documentation.
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
Made-with: Cursor
2026-03-16 20:04:16 +01:00
17dff0ba25
docs: rename package discovery to feature discovery and reduce duplication
...
Rename "package discovery" to "feature discovery" across all plugin
READMEs and docs to match the established terminology. Slim down the
Feature Discovery section in the architecture docs to avoid duplicating
the configuration details now covered in the installing plugins page.
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
Made-with: Cursor
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
Made-with: Cursor
2026-03-04 12:57:49 +01:00
5a463b320c
docs: update frontend plugin docs to default to new frontend system
...
Restructure plugin documentation so that the new frontend system is
the default, unlabeled installation path. Old frontend system
instructions are moved to a dedicated "Old Frontend System" section.
Add a new "Installing Plugins" page to the frontend system docs
covering package discovery, manual installation, and configuration.
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
Made-with: Cursor
2026-03-04 11:24:35 +01:00
32cb991728
Merge pull request #31842 from milliehartnt123/milliehartnt123-create-ui-doc
...
Updated Using Backstage documentation for Feature Issue 21943 Write a UI Guide
2026-02-27 11:15:35 -06:00
06366a7fa4
fix prettier
...
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com >
2026-02-27 10:07:15 -05:00
68d8a1acc3
Fix prettier errors
...
viewing-catalog.md
viewing-entity-relationships.md
filter-catalog.md
register-a-component.md
unregister-delete-component.md
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-24 11:09:43 -05:00
8f3a37aec6
Try to fix prettier errors in create-a-component
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-24 10:31:56 -05:00
33495b0d15
Update component creation instructions with NODE_OPTIONS note
...
Added a note about the required NODE_OPTIONS environment variable for templates.
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-24 09:41:09 -05:00
7d99411665
Added space after Direction to fix formatting
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-19 14:18:51 -05:00
85eef52678
try to fix line endings and prettier errors
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-19 09:51:00 -05:00
db13606feb
Fix grammatical error in component creation instructions
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-18 17:36:44 -05:00
5b2da65477
Refactor wording for clarity in component creation guide
...
Removed bulleted list of catalog-info.yaml, index.js, and package.json. Reworded paragraph but kept example of catalog-info.yaml file.
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-18 17:20:39 -05:00
7261f57f52
Fix formatting of 'Aggregated Relations' list item
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-18 16:06:59 -05:00
a0cb5e833d
Fix link to standalone app installation guide
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-18 16:05:33 -05:00
5ab460fc22
Fix link to standalone app installation
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-18 15:44:59 -05:00
001c28bdb9
Improve documentation on entity relationships and filters
...
Updated formatting and clarified steps for viewing entity relationships and filtering in the Catalog Graph.
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-18 15:24:51 -05:00
87de61ea70
Fix typo in viewing-catalog.md
...
Changed alt text from Viewing entity relations to Viewing entity relationships to align with the page title.
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-18 14:32:53 -05:00
1c49da8e6f
fix: danger note taking the whole section ( #32906 )
...
Signed-off-by: Juan Pablo Garcia Ripa <sarabadu@gmail.com >
2026-02-18 09:02:53 -05:00
46b865f2eb
Try to fix prettier errors in filter-catalog.md
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-17 12:41:51 -05:00
39641a9597
Fix punctuation in create-a-component.md
...
Added a colon at the end of the sentence for clarity.
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-17 09:43:05 -05:00
25efe44acd
Fix formatting and update step numbers in guide
...
Updated step numbering and corrected formatting in the guide.
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-17 09:41:48 -05:00
e46ec22005
Merge branch 'backstage:master' into milliehartnt123-create-ui-doc
2026-02-17 09:23:28 -05:00
c546f03134
Correct capitalization in update-a-component.md
...
Changed software catalog to Software Catalog
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-16 10:31:34 -05:00
5b3a6dd51a
Correct capitalization of 'Catalog' in documentation
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-16 10:29:22 -05:00
9e929cd732
Correct capitalization in registration guide
...
Updated capitalization of 'Catalog' and 'Software Catalog' for consistency.
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-16 10:25:24 -05:00
f822a2d82e
Update filter-catalog.md Changed catalog to Catalog
...
Changed catalog to Catalog
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-16 10:22:39 -05:00
363eac721c
docs: follow up on PR: #32844 where update the database getting-started docker example to newest version
...
Signed-off-by: Linus Andersson <sunil.andersson@gmail.com >
2026-02-14 11:28:49 +01:00
21d0abcb2c
Fix capitalization of 'Software Catalog' in documentation
...
Capitalized Catalog and Software Catalog as proper nouns.
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-13 14:34:35 -05:00
4e4fcfd5ff
Clarify entity types in catalog overview
...
Updated the overview section to clarify the types of entities in the Catalog. Changed to only include 4 main types here and point them to the Technical Overview for a description of all of the types. Also edited Catalog so it is always a proper noun and capitalized.
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-13 14:30:23 -05:00
cdb4719e08
docs: use postgres:17-bookworm in tutorial
...
Signed-off-by: Linus Andersson <sunil.andersson@gmail.com >
2026-02-13 19:08:52 +01:00
84fdb7edab
Fix formatting issue in unregister-delete-component.md
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-12 16:33:55 -05:00
0b3fabed0f
Fix formatting of 'Aggregated Relations' in documentation
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-12 16:25:12 -05:00
7ecc9bcd78
Fix typo in image caption for import step
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-12 16:23:45 -05:00
2fafccb241
Try to fix prettier errors in filter-catalog.md
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-12 15:38:33 -05:00
fad83fc840
Fix typo in error image filename
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-12 15:24:39 -05:00
d3fa2a8d36
Fix formatting in unregister-delete-component.md
...
Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com >
2026-02-12 09:50:04 -05:00
milliehartnt123