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

some a11y fix

Browse Source 
Signed-off-by: npiyush97 <npiyush35@gmail.com>
This commit is contained in:
npiyush97
2024-01-25 22:38:21 +05:30
parent 8cea347e80
commit f9b5866902
5 changed files with 40 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/software-catalog/index.md
+7 -7
View File
@@ -36,7 +36,7 @@ The Software Catalog is available to browse at `/catalog`. If you've followed
[Getting Started with Backstage](../../getting-started), you should be able to
browse the catalog at `http://localhost:3000`.
![](../../assets/software-catalog/software-catalog-home.png)
![screenshot of software catalog](../../assets/software-catalog/software-catalog-home.png)
## Adding components to the catalog
@@ -55,7 +55,7 @@ There are 3 ways to add components to the catalog:
Users can register new components by going to `/create` and clicking the
**REGISTER EXISTING COMPONENT** button:
![](../../assets/software-catalog/bsc-register-1.png)
![screenshot of manually register existing component](../../assets/software-catalog/bsc-register-1.png)
Backstage expects the full URL to the YAML in your source control. Example:
@@ -66,7 +66,7 @@ https://github.com/backstage/backstage/blob/master/packages/catalog-model/exampl
_More examples can be found
[here](https://github.com/backstage/backstage/tree/master/packages/catalog-model/examples)._
![](../../assets/software-catalog/bsc-register-2.png)
![screenshot of creating new components](../../assets/software-catalog/bsc-register-2.png)
It is important to note that any kind of software can be registered in
Backstage. Even if the software is not maintained by your company (SaaS
@@ -100,7 +100,7 @@ More information about catalog configuration can be found
Teams owning the components are responsible for maintaining the metadata about
them, and do so using their normal Git workflow.
![](../../assets/software-catalog/bsc-edit.png)
![screenshot of updating component metadata](../../assets/software-catalog/bsc-edit.png)
Once the change has been merged, Backstage will automatically show the updated
metadata in the software catalog after a short while.
@@ -112,14 +112,14 @@ in user. But you can also switch to _All_ to see all the components across your
company's software ecosystem. Basic inline _search_ and _column filtering_ makes
it easy to browse a big set of components.
![](../../assets/software-catalog/bsc-search.png)
![screenshot of finding software in the catalog](../../assets/software-catalog/bsc-search.png)
## Starring components
For easy and quick access to components you visit frequently, Backstage supports
_starring_ of components:
![](../../assets/software-catalog/bsc-starred.png)
![screenshot of starred components](../../assets/software-catalog/bsc-starred.png)
## Integrated tooling through plugins
@@ -130,7 +130,7 @@ infrastructure UIs (and incurring additional cognitive overhead each time they
make a context switch), most of these tools can be organized around the entities
in the catalog.
![tools](https://backstage.io/assets/images/tabs-abfdf72185d3ceb1d92c4237f7f78809.png)
![screenshot of tools](https://backstage.io/assets/images/tabs-abfdf72185d3ceb1d92c4237f7f78809.png)
The Backstage platform can be customized by incorporating
[existing open source plugins](https://github.com/backstage/backstage/tree/master/plugins),