Merge pull request #32061 from elaine-mattos/feat/add-description-plugin-feature-flags
feat(core-plugin-api): add optional description to plugin feature flags
This commit is contained in:
@@ -19,11 +19,18 @@ import { createPlugin } from '@backstage/core-plugin-api';
|
||||
|
||||
export const examplePlugin = createPlugin({
|
||||
// ...
|
||||
featureFlags: [{ name: 'show-example-feature' }],
|
||||
featureFlags: [
|
||||
{
|
||||
name: 'show-example-feature',
|
||||
description: 'Enables the new beta dashboard view',
|
||||
},
|
||||
],
|
||||
// ...
|
||||
});
|
||||
```
|
||||
|
||||
Note that the `description` property is optional. If not provided, the default "Registered in {pluginId} plugin" message is shown.
|
||||
|
||||
### In the application
|
||||
|
||||
Defining a feature flag in the application is done by adding feature flags in `featureFlags` array in the
|
||||
|
||||
Reference in New Issue
Block a user