File tree Expand file tree Collapse file tree 2 files changed +51
-0
lines changed Expand file tree Collapse file tree 2 files changed +51
-0
lines changed Original file line number Diff line number Diff line change 1+ ---
2+ ' @backstage-community/plugin-sonarqube ' : patch
3+ ---
4+
5+ new frontend system docs added
Original file line number Diff line number Diff line change @@ -108,6 +108,52 @@ spec:
108108
109109` YOUR_INSTANCE_NAME/` is optional and will query the default instance if not provided.
110110
111+ # # New Frontend System
112+
113+ # ## Setup
114+
115+ If you're using [feature discovery](https://backstage.io/docs/frontend-system/architecture/app/#feature-discovery),
116+ the plugin will be automatically discovered and enabled.
117+
118+ Otherwise, you can manually enable the plugin by adding it to your app :
119+
120+ ` ` ` tsx
121+ // packages/app/src/App.tsx
122+ import sonarqubePlugin from '@backstage-community/plugin-sonarqube/alpha';
123+
124+ const app = createApp({
125+ features: [
126+ // ...
127+ sonarqubePlugin,
128+ ],
129+ });
130+ ` ` `
131+
132+ # ## Extensions
133+
134+ The following extensions are available in the plugin :
135+
136+ - ` api:sonarqube/sonarqube-api`
137+ - ` entity:sonarqube/entity-sonarqube-card`
138+ - ` entity:sonarqube/sonarqube-related-entities-overview`
139+
140+ # ## Legacy Frontend System
141+
142+ When using the legacy frontend system, customize through component props :
143+
144+ - **`EntitySonarQubeCard`** - Props: `variant`, `missingAnnotationReadMoreUrl`, `duplicationRatings`
145+ - **`SonarQubeRelatedEntitiesOverview`** - Props: `relationType`, `entityKind`
146+ - **`EntitySonarQubeContentPage`** - Props: `title`, `supportTitle`, `missingAnnotationReadMoreUrl`
147+
148+ Example :
149+
150+ ` ` ` tsx
151+ <EntitySonarQubeCard
152+ variant="gridItem"
153+ missingAnnotationReadMoreUrl="https://your-docs-url.com"
154+ />
155+ ` ` `
156+
111157# ## Integrating with `EntityPage` (New Frontend System)
112158
113159Follow this section if you are using Backstage's [new frontend system](https://backstage.io/docs/frontend-system/).
You can’t perform that action at this time.
0 commit comments