paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 27 Packages Projects Releases Wiki Activity

Merge pull request #24365 from sagardesai1/update/techdocs

Browse Source 
Updating Readme docs
This commit is contained in:
Patrik Oldsberg
2024-04-22 14:07:23 +02:00
committed by GitHub
parent 9624efb688 d2cc139506
commit 1d02904ffd
2 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/eighty-bats-stare.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-techdocs': patch
---
Update path in Readme for Plugin Techdocs to show the correct setup information.
plugins/techdocs/README.md
+1 -1
View File
@@ -10,4 +10,4 @@ Refer to our [configuration reference](../../docs/features/techdocs/configuratio
### TechDocs Storage API
The default setup of TechDocs assumes that your documentation is accessed by reading a page with the format of `<storageUrl>/<entity kind>/<entity namespace>/<entity name>`. This can be configured by [implementing a new techdocs storage API](https://backstage.io/docs/features/techdocs/how-to-guides#how-to-implement-your-own-techdocs-apis).
The default setup of TechDocs assumes that your documentation is accessed by reading a page with the format of `<storageUrl>/<entity namespace>/<entity kind>/<entity name>`. This can be configured by [implementing a new techdocs storage API](https://backstage.io/docs/features/techdocs/how-to-guides#how-to-implement-your-own-techdocs-apis).