Karthik
5ef8d166cb
feat(techdocs): add app-config option to disable external font download
...
Signed-off-by: Karthik <karthik.jk11@gmail.com >
2026-03-31 21:30:45 +05:30
Andre Wanlin
f4c012dee3
Merge pull request #33064 from awanlin/docs/nfs-getting-started-auth
...
[Docs] NFS - Authentication
2026-03-17 12:35:02 -05: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
Andre Wanlin
11e380b83a
Invert based on feedback
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2026-03-17 11:15:41 -05:00
Andre Wanlin
9a82ed5269
[Docs] NFS - Authentication
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2026-03-17 10:30:58 -05:00
Gabriel Dugny
895563a1b7
fix(techdocs): Disable LighBox addon for images wrapped in links
...
Signed-off-by: Gabriel Dugny <gabriel.dugny@believe.com >
# Conflicts:
# docs/features/techdocs/addons--new.md
# docs/features/techdocs/addons.md
# Conflicts:
# docs/features/techdocs/addons--new.md
2026-03-14 11:27:11 +01:00
chanchalkhatri19
af64800234
docs: fix TechDocs Addons link
...
Signed-off-by: chanchalkhatri19 <chanchal.khatri01@infosys.com >
2026-03-09 10:45:13 +00:00
Andre Wanlin
5142f60de3
[Doc] Removed Mentions of the New Backend System
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2026-02-28 11:22:02 -06:00
Gabriel Dugny
de62a9d322
chore: update dependency commander to v14, remove old @types/commander
...
Signed-off-by: Gabriel Dugny <gabriel.dugny@believe.com >
2026-02-16 17:29:25 +01:00
chanchalkhatri19
c0aad22784
docs: fix TechDocs CLI README link path
...
Signed-off-by: chanchalkhatri19 <chanchal.khatri01@infosys.com >
2026-02-12 11:47:31 +00:00
Andre Wanlin
be7c1d73b2
Merge pull request #31526 from aoitoya/techdocs-config-md
...
TechDocs Configuration documentation update
2026-02-05 16:42:47 -06:00
aramissennyeydd
efbf232bfa
fix: update more /docs/references links
...
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com >
2026-02-04 10:11:36 -06:00
toya
9473854190
Update techdocs configuration documentation and vocabulary
...
Signed-off-by: toya <96932308+toyaAoi@users.noreply.github.com >
2026-01-31 07:32:49 +05:30
Saptarshi Mula
3934a9f990
Merge branch 'backstage:master' into techdocs-config-md
2026-01-21 22:06:18 +05:30
Vincenzo Scamporlino
b5914dfe6d
docs: clarify techdocs s3 buckets integration
...
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2025-12-04 10:07:22 +01:00
toya
e4c1ba6a53
techdocs config doc update
...
Signed-off-by: toya <96932308+toyaAoi@users.noreply.github.com >
Signed-off-by: Saptarshi Mula <96932308+toyaAoi@users.noreply.github.com >
2025-10-25 23:29:11 +05:30
Fredrik Adelöw
6a42abe379
Merge pull request #31058 from AdityaK60/fix-microsite-warning
...
Fixed duplicate route warning for TechDocs Addons documentation in Do…
2025-09-22 22:40:52 +02:00
Aditya Kumar
a4d3260567
Update addons--new.md
...
Signed-off-by: Aditya Kumar <136452216+AdityaK60@users.noreply.github.com >
2025-09-15 15:11:43 +05:30
Aditya Kumar
7a40a90c64
Update addons.md
...
Signed-off-by: Aditya Kumar <136452216+AdityaK60@users.noreply.github.com >
2025-09-15 15:10:38 +05:30
Hayato Kihara
d03010ec9b
docs: Add missing TOC entries to TechDocs FAQ ( #30900 )
...
Signed-off-by: Hayato Kihara <kai.21banana@gmail.com >
2025-09-10 14:23:23 -04:00
Owen Shartle
169ae728b8
Moving the TechDocs entity annotation FAQ entry.
...
Signed-off-by: Owen Shartle <timeloveinvent+github@gmail.com >
2025-09-06 21:23:00 -04:00
Aditya Kumar
01bf98c778
Fixed duplicate route warning for TechDocs Addons documentation in Docusaurus
...
Signed-off-by: Aditya Kumar <aditya.kumar60@infosys.com >
2025-09-04 14:40:48 +05:30
Owen Shartle
a0b604cb6a
Adding handling which checks if the current entity (the catalog entity being loaded) has an annotation for an external entity's TechDocs. If it does then we will redirect there rather than allowing a 404 (mic drop). This helps keep older URLs routing to the updated locations.
...
Adding changesets.
Adding test coverage for external TechDocs entitiy redirect.
Signed-off-by: Owen Shartle <timeloveinvent+github@gmail.com >
2025-08-25 15:39:29 -04:00
Jonas Mai
c118dcda83
docs(techdocs): Azure Storage Account Auth Guide Update ( #30304 )
...
* Azure Storage Account Auth Guide Update
Describe how any method supported by `DefaultAzureCredential ` can be used to authenticate.
Signed-off-by: Jonas Mai <hubwoop@users.noreply.github.com >
* Update using-cloud-storage.md
Signed-off-by: Jonas Mai <hubwoop@users.noreply.github.com >
* Replace VMs with Virtual Machines
As recommended by code-review
Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com >
Signed-off-by: Jonas Mai <hubwoop@users.noreply.github.com >
---------
Signed-off-by: Jonas Mai <hubwoop@users.noreply.github.com >
Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com >
2025-07-28 13:52:47 -04:00
Nick Hudkins
cb0541f294
feat(sanitizer): add support for allowlisting additional URI protocols
...
Signed-off-by: Nick Hudkins <nick@nickhudkins.com >
2025-07-21 13:23:32 -04:00
Andre Wanlin
b5545900a4
Initial removal
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2025-06-06 13:14:54 -05:00
Chris Suich
992da5cbdc
update docs to indicate this works standalone
...
Signed-off-by: Chris Suich <csuich2@gmail.com >
2025-05-05 10:54:20 -04:00
Chris Suich
ec7b35d77e
feat: add techdocs-entity-path annotation for techdocs deep linking
...
This annotation enables specifying a path within another entities
techdocs to use as the root techdocs page.
Signed-off-by: Chris Suich <csuich2@gmail.com >
2025-04-28 11:32:28 -04:00
Gabriel Dugny
14bddfd10f
docs: Fix typos
...
Signed-off-by: Gabriel Dugny <gabriel.dugny@believe.com >
2025-04-18 17:32:34 +02:00
Paul Schultz
2e26579e06
chore: update react imports
...
Signed-off-by: Paul Schultz <pschultz@pobox.com >
2025-04-08 07:35:24 -05:00
Laimis Juzeliūnas
148a118bde
docs(techdocs): update how-to-guide for non-root paths
...
This commit/change updates the Techdocs how-to-guide to include an explanation about mandatory suffix for non-root paths.
Signed-off-by: Laimis Juzeliūnas <asnelaimis@gmail.com >
2025-03-12 11:23:51 +02:00
Andre Wanlin
40ebba446f
Update docs/features/techdocs/getting-started.md
...
Co-authored-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com >
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com >
2025-02-28 14:55:30 -06:00
Andre Wanlin
9bc50f7e20
Removed TechDocs legacy backend docs
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2025-02-28 14:11:07 -06:00
Jackson Chen
b5a82087a7
techdocs: add extensions for techdocs addons ( #28644 )
...
* techdocs: add extensions for techdocs addons
Signed-off-by: Jackson Chen <jacksonc@spotify.com >
* techdocs: add blueprint extension for techdocs addons
Signed-off-by: Jackson Chen <jacksonc@spotify.com >
* techdocs: move addons blueprint to alpha
Signed-off-by: Jackson Chen <jacksonc@spotify.com >
* techdocs: add addon extensions for new frontend system and add docs
Signed-off-by: Jackson Chen <jacksonc@spotify.com >
* techdocs: fix addon modules naming patterns
Signed-off-by: Jackson Chen <jacksonc@spotify.com >
* techdocs: update test utils with entity presentation api
Signed-off-by: Jackson Chen <jacksonc@spotify.com >
---------
Signed-off-by: Jackson Chen <jacksonc@spotify.com >
2025-02-21 16:39:45 -05:00
John Philip
47e429861d
Merge pull request #27853 from autodesk-forks/nikolarAutodesk/makeTechDocsCustomizable
...
[plugin-techdocs] Add props to increase flexibility and reusability
2025-01-20 03:25:59 -05:00
Laimis Juzeliūnas
8de3d2d53d
feat(techdocs): add support for AWS S3 retries in publisher ( #28446 )
...
This change is to allow a configurable retry in Backstage TechDocs AWS S3 publisher.
It introduces a new possible option for techdocs-cli publish called --awsMaxAttempts. This configuration when specified as a number translates to maxAttempts that is compatible with aws-sdk/client-s3 (JavaScript v3) S3Client class. The change will not break existing configuration setups - maxAttempts is optional and fallbacks to already existing defaults if not specified.
Signed-off-by: Laimis Juzeliūnas <asnelaimis@gmail.com >
2025-01-14 13:15:16 -05:00
nikolar
7dcbc669b7
clarify howtoguide
...
Signed-off-by: nikolar <reyna.nikolayev@autodesk.com >
2025-01-13 11:25:11 -08:00
nikolar
0fc1936db4
fix custom props
...
Signed-off-by: nikolar <reyna.nikolayev@autodesk.com >
2024-12-20 17:39:44 -08:00
Reyna Nikolayev
845b0f17f5
Merge branch 'master' into nikolarAutodesk/makeTechDocsCustomizable
...
Signed-off-by: Reyna Nikolayev <146387693+nikolarAutodesk@users.noreply.github.com >
2024-12-10 16:40:53 -08:00
Fredrik Adelöw
973dd6f25d
fix some little things that vale was complaining about
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2024-12-10 14:31:54 +01:00
nikolar
351952cb93
renaming
...
Signed-off-by: nikolar <reyna.nikolayev@autodesk.com >
2024-12-03 15:41:04 -08:00
nikolar
1f40e6bf88
add docs and clean up
...
Signed-off-by: nikolar <reyna.nikolayev@autodesk.com >
2024-12-02 22:35:58 -08:00
Jan
062f6fdb56
docs(techdocs): Update Docker command to install mkdocs
...
Signed-off-by: Jan <herr.jan.heller@googlemail.com >
2024-11-22 13:13:58 +01:00
Alex Lorenzi
0df455f94b
Update how-to-guides.md
...
small grammar update
Signed-off-by: Alex Lorenzi <671432+alexlorenzi@users.noreply.github.com >
2024-11-14 16:53:22 -05:00
Alex Lorenzi
0c9bd0abe5
Updated mermaid installation docs
...
Signed-off-by: Alex Lorenzi <alorenzi@spotify.com >
2024-11-14 16:41:03 -05:00
Harsha Teja Kanna
4f0cb89c42
Add DomPurify sanitizer custom elements configuration ( #26989 )
...
* Add DomPurify sanitizer custom elements configuration
---------
Signed-off-by: Harsha Teja Kanna <h7kanna@gmail.com >
2024-10-17 13:21:56 -04:00
Patrik Oldsberg
bc71718834
update docs to remove /alpha
...
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
2024-10-11 16:50:08 +02:00
Adrian Kosiński
fbdc63116c
feat(techdocs): Allow to pass options to GCS publisher ( #26836 )
...
* feat(techdocs): Allow to pass options to GCS publisher
Signed-off-by: Adrian Kosinski <adrian.kosinski@allegro.com >
---------
Signed-off-by: Adrian Kosinski <adrian.kosinski@allegro.com >
2024-10-01 13:40:47 -04:00
Fredrik Adelöw
123d514d11
Merge pull request #25084 from wedge-jarrad/download-link-docs
...
Add examples for creating download links
2024-09-27 15:07:14 +02:00
Fredrik Adelöw
d5240d303a
Update docs/features/techdocs/how-to-guides.md
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2024-09-27 14:24:47 +02:00