@axis-backstage/plugin-readme 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,11 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
Welcome to the readme plugin!
|
|
4
4
|
|
|
5
|
-
|
|
6
6
|
|
|
7
7
|
## Introduction
|
|
8
8
|
|
|
9
|
-
The `
|
|
9
|
+
The `Readme-plugin` enables easy access and viewing of the README file. By having information such as the project's purpose, usage instructions, or installation details as a central part of the EntityPage, we hope to improve the `onboarding and understanding of entities`.
|
|
10
|
+
|
|
11
|
+
The plugin **supports all ScmIntegrations**, like Gerrit & GitLab. This makes it possible for organizations with many Source Code Integrations to use the same plugin.
|
|
12
|
+
|
|
13
|
+
It also supports various file extentions such as README.md, README.MD, README.txt, README, and README.rst.
|
|
10
14
|
|
|
11
15
|
### Where can the plugin find my README file?
|
|
12
16
|
|
|
@@ -48,9 +52,9 @@ const overviewContent = (
|
|
|
48
52
|
|
|
49
53
|
The readme card is located in the overview page on the entity page. From the card header it is also possible to open a dialog displaying the full README.md.
|
|
50
54
|
|
|
51
|
-
|
|
52
56
|
|
|
53
|
-
|
|
54
58
|
|
|
55
59
|
### Troubleshooting
|
|
56
60
|
|