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

Update image links to use markdown syntax

Browse Source 
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>
This commit is contained in:
Johan Haals
2023-02-21 11:43:14 +01:00
parent 2b65a84775
commit 7a23cdfa59
10 changed files with 43 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/search/architecture.md
+3 -1
View File
@@ -9,7 +9,9 @@ to support a wide variety of search engines, while providing a simple developer
experience for plugin developers, and a good out-of-the-box experience for
Backstage end-users.
<img data-zoomable src="../../assets/search/architecture.drawio.svg" alt="Search Architecture" />
<!-- todo: Needs zoomable plugin -->
![Search Architecture](../../assets/search/architecture.drawio.svg)
At a base-level, we want to support the following:
docs/features/techdocs/addons.md
+3 -1
View File
@@ -39,7 +39,9 @@ representative of physical spaces in the TechDocs UI:
- `Component`: A [proposed-but-not-yet-implemented](https://github.com/backstage/backstage/issues/11109)
virtual location, aimed at simplifying a common type of Addon.
<img data-zoomable src="../../assets/techdocs/addon-locations.png" alt="TechDocs Addon Location Guide" />
<!-- todo: Needs zoomable plugin -->
![TechDocs Addon Location Guide](../../assets/techdocs/addon-locations.png)
### Addon Registry
docs/features/techdocs/architecture.md
+6 -2
View File
@@ -9,7 +9,9 @@ description: Documentation on TechDocs Architecture
When you deploy Backstage (with TechDocs enabled by default), you get a basic
out-of-the box experience.
<img data-zoomable src="../../assets/techdocs/architecture-basic.drawio.svg" alt="TechDocs Architecture diagram" />
<!-- todo: Needs zoomable plugin -->
![TechDocs Architecture diagram](../../assets/techdocs/architecture-basic.drawio.svg)
> Note: See below for our recommended deployment architecture which takes care
> of stability, scalability and speed. Also look at the
@@ -42,7 +44,9 @@ storage system (e.g. AWS S3, GCS or Azure Blob Storage). Read more in
This is how we recommend deploying TechDocs in a production environment.
<img data-zoomable src="../../assets/techdocs/architecture-recommended.drawio.svg" alt="TechDocs Architecture diagram" />
<!-- todo: Needs zoomable plugin -->
![TechDocs Architecture diagram](../../assets/techdocs/architecture-recommended.drawio.svg)
The key difference in the recommended deployment approach is where the docs are
built.
docs/features/techdocs/getting-started.md
+6 -2
View File
@@ -89,11 +89,15 @@ const AppRoutes = () => {
I know, you're curious to see how it looks, aren't you? See the image below:
<img data-zoomable src="../../assets/techdocs/report-issue-addon.png" alt="TechDocs Report Issue Add-on" />
<!-- todo: Needs zoomable plugin -->
![TechDocs Report Issue Add-on](../../assets/techdocs/report-issue-addon.png)
By clicking the open new issue button, you will be redirected to the new issue page according to the source code provider you are using:
<img data-zoomable src="../../assets/techdocs/report-issue-template.png" alt="TechDocs Report Issue Template" />
<!-- todo: Needs zoomable plugin -->
![TechDocs Report Issue Template](../../assets/techdocs/report-issue-template.png)
That's it! Now, we need the TechDocs Backend plugin for the frontend to work.