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

Merge pull request #17013 from mario-mui/doc/plugin

Browse Source 
Doc/plugin
This commit is contained in:
Patrik Oldsberg
2023-03-28 10:35:14 +02:00
committed by GitHub
parent 0aca3fad2f f737730146
commit 12f1a5feac
2 changed files with 14 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/plugins/composability.md
+8 -8
View File
@@ -196,14 +196,14 @@ const App = () => (
There are a couple of naming patterns to adhere to as you build plugins, which
helps clarify the intent and usage of the exports.
| Description | Pattern | Examples |
| --------------------- | ----------------- | ---------------------------------------------------- |
| Top-level Pages | `\*Page` | `CatalogIndexPage`, `SettingsPage`, `LighthousePage` |
| Entity Tab Content | `Entity\*Content` | `EntityJenkinsContent`, `EntityKubernetesContent` |
| Entity Overview Card | `Entity\*Card` | `EntitySentryCard`, `EntityPagerDutyCard` |
| Entity Conditional | `is\*Available` | `isPagerDutyAvailable`, `isJenkinsAvailable` |
| Plugin Instance | `\*Plugin` | `jenkinsPlugin`, `catalogPlugin` |
| Utility API Reference | `\*ApiRef` | `configApiRef`, `catalogApiRef` |
| Description | Pattern | Examples |
| --------------------- | ---------------- | ---------------------------------------------------- |
| Top-level Pages | `*Page` | `CatalogIndexPage`, `SettingsPage`, `LighthousePage` |
| Entity Tab Content | `Entity*Content` | `EntityJenkinsContent`, `EntityKubernetesContent` |
| Entity Overview Card | `Entity*Card` | `EntitySentryCard`, `EntityPagerDutyCard` |
| Entity Conditional | `is*Available` | `isPagerDutyAvailable`, `isJenkinsAvailable` |
| Plugin Instance | `*Plugin` | `jenkinsPlugin`, `catalogPlugin` |
| Utility API Reference | `*ApiRef` | `configApiRef`, `catalogApiRef` |
### Routing System
docs/plugins/structure-of-a-plugin.md
+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.