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

docs: imp plugin composability naming patterns

Browse Source 
Signed-off-by: rui ma <ruima@alauda.io>
This commit is contained in:
rui ma
2023-03-22 15:14:54 +08:00
parent a69358db72
commit f737730146
1 changed files with 8 additions and 8 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