Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions workspaces/apache-airflow/.changeset/witty-actors-begin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@backstage-community/plugin-apache-airflow': patch
---

Added New Frontend System documentation
45 changes: 45 additions & 0 deletions workspaces/apache-airflow/plugins/apache-airflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,51 @@ password of your instance.
echo -n "airflow:airflow" | base64 -w0
```

## New Frontend System

### Setup

If you're using [feature discovery](https://backstage.io/docs/frontend-system/architecture/app/#feature-discovery),
the plugin will be automatically discovered and enabled.

Otherwise, you can manually enable the plugin by adding it to your app:

```tsx
// packages/app/src/App.tsx
import sonarqubePlugin from '@backstage-community/plugin-sonarqube/alpha';
const app = createApp({
features: [
// ...
sonarqubePlugin,
],
});
```

### Extensions

The following extensions are available in the plugin:

- `api:sonarqube/sonarqube-api`
- `entity:sonarqube/entity-sonarqube-card`
- `entity:sonarqube/sonarqube-related-entities-overview`

### Legacy Frontend System

When using the legacy frontend system, customize through component props:

- **`EntitySonarQubeCard`** - Props: `variant`, `missingAnnotationReadMoreUrl`, `duplicationRatings`
- **`SonarQubeRelatedEntitiesOverview`** - Props: `relationType`, `entityKind`
- **`EntitySonarQubeContentPage`** - Props: `title`, `supportTitle`, `missingAnnotationReadMoreUrl`

Example:

```tsx
<EntitySonarQubeCard
variant="gridItem"
missingAnnotationReadMoreUrl="https://your-docs-url.com"
/>
```

## Development

For local development, you can setup a local Airflow instance for development
Expand Down