From f737730146d52c69041b497de99862a12a1a5ba5 Mon Sep 17 00:00:00 2001 From: rui ma Date: Wed, 22 Mar 2023 15:14:54 +0800 Subject: [PATCH] docs: imp plugin composability naming patterns Signed-off-by: rui ma --- docs/plugins/composability.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/plugins/composability.md b/docs/plugins/composability.md index 124a612f26..b18bae31c6 100644 --- a/docs/plugins/composability.md +++ b/docs/plugins/composability.md @@ -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