doc: fix some structure of a plugin doc invalid info

Signed-off-by: rui ma <ruima@alauda.io>
This commit is contained in:
rui ma
2023-03-22 18:06:05 +08:00
parent a5999c5a17
commit a69358db72
+6 -7
View File
@@ -13,7 +13,8 @@ The new plugin should look something like:
```
new-plugin/
dist/
dev/
index.ts
node_modules/
src/
components/
@@ -29,11 +30,10 @@ new-plugin/
plugin.test.ts
plugin.ts
routes.ts
jest.config.js
jest.setup.ts
setupTests.ts
.eslintrc.js
package.json
README.md
tsconfig.json
```
You might note a thing or two. Yes, a plugin looks like a mini project on it's
@@ -48,8 +48,7 @@ folder.
## Base files
In the root folder you have some configuration for typescript and jest, the test
runner. You get a readme to populate with info about your plugin and a
You get a readme to populate with info about your plugin and a
package.json to declare the plugin dependencies, metadata and scripts.
## The plugin file
@@ -92,7 +91,7 @@ The generated plugin includes two example components to showcase how we
structure our plugins. There are usually one or multiple page components and
next to them you can split up the UI in as many components as you feel like.
We have the `ExamplePage` to show an example Backstage page component. The
We have the `ExampleComponent` to show an example Backstage page component. The
`ExampleFetchComponent` showcases the common task of making an async request to
a public API and plot the response data in a table using Material-UI components.