Skip to content

Commit 5114558

Browse files
committed
docs(apache-airflow): add New Frontend System documentation community-plugins
Signed-off-by: Dharmik <[email protected]>
1 parent ee2461c commit 5114558

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@backstage-community/plugin-apache-airflow': patch
3+
---
4+
5+
add New Frontend System documentation for apache airflow

workspaces/apache-airflow/plugins/apache-airflow/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,49 @@ password of your instance.
107107
echo -n "airflow:airflow" | base64 -w0
108108
```
109109

110+
## New Frontend System
111+
112+
### Setup
113+
114+
If you're using [feature discovery](https://backstage.io/docs/frontend-system/architecture/app/#feature-discovery),
115+
the plugin will be automatically discovered and enabled.
116+
117+
Otherwise, you can manually enable the plugin by adding it to your app:
118+
119+
```tsx
120+
// packages/app/src/App.tsx
121+
import apacheAirflowPlugin from '@backstage-community/plugin-apache-airflow/alpha';
122+
123+
const app = createApp({
124+
features: [
125+
// ...
126+
apacheAirflowPlugin,
127+
],
128+
});
129+
```
130+
131+
### Extensions
132+
133+
The following extensions will be available in the plugin:
134+
135+
- `api:apache-airflow/apache-airflow-api`
136+
- `page:apache-airflow/apache-airflow-page`
137+
138+
## Legacy Frontend System
139+
140+
When using the legacy frontend system, customize through component props:
141+
142+
- **`ApacheAirflowPage`** - Full page component (no props)
143+
- **`ApacheAirflowDagTable`** - Props: `dagIds?: string[]`
144+
145+
Example:
146+
147+
```tsx
148+
<ApacheAirflowDagTable
149+
dagIds={['example_bash_operator', 'example_branch_datetime_operator_2']}
150+
/>
151+
```
152+
110153
## Development
111154

112155
For local development, you can setup a local Airflow instance for development

0 commit comments

Comments
 (0)