IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Storybook: Add documentation to PluginSignatureBadge story (#51645)

Browse Source 
* Import the mdx documentation file to PluginSignatureBadge.story.tsx and add to its export defaul

* Create the mdx file of PluginSignatureBadge with its information

* Fix signed PluginSignatureBadge status

* Modify text according to reviewer suggestions

* betterer

Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
This commit is contained in:
eledobleefe 2022-07-05 15:38:26 +02:00 committed by GitHub
parent 18b481cedc
commit 13fbe6ed28
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 50 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.betterer.results
View File

@ -10347,9 +10347,6 @@ exports[`no undocumented stories`] = {
"packages/grafana-ui/src/components/PanelChrome/PanelChrome.story.tsx:5381": [
[0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"]
],
"packages/grafana-ui/src/components/PluginSignatureBadge/PluginSignatureBadge.story.tsx:5381": [
[0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"]
],
"packages/grafana-ui/src/components/QueryField/QueryField.story.tsx:5381": [
[0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"]
],

43
packages/grafana-ui/src/components/PluginSignatureBadge/PluginSignatureBadge.mdx Normal file
View File

@ -0,0 +1,43 @@
import { Meta, Preview, Props } from '@storybook/addon-docs/blocks';
import { PluginSignatureBadge } from './PluginSignatureBadge';
<Meta title="MDX|PluginSignatureBadge" component={PluginSignatureBadge} />
# Plugin Signature Badge
The Plugin Signature Badge can be found in each information plugin card of the configuration plugins panel (Grafana menu > Configuration > Plugins).
This is a security measure to make sure plugins haven't been tampered with. Upon loading, Grafana checks to see the plugin signature status.
## Badges:
1.- Core: this badge indicates that the plugin has been built into Grafana.
<Preview>
<PluginSignatureBadge status="internal" />
</Preview>
2.- Signed: the plugin's signature was successfully verified.
<Preview>
<PluginSignatureBadge status="valid" />
</Preview>
3.- Invalid signature: this plugin has a invalid signature.
<Preview>
<PluginSignatureBadge status="invalid" />
</Preview>
4.- Modified signature: this plugin has changed since it was signed. This may indicate malicious intent.
<Preview>
<PluginSignatureBadge status="modified" />
</Preview>
5.- Unsigned: the plugin is not signed. In this case, as upon loading Grafana checks the plugins signature, Grafana will not load or start it. Furthermore, it will write an error message to the server log.
<Preview>
<PluginSignatureBadge status="unsigned" />
</Preview>
<Props of={PluginSignatureBadge} />

7
packages/grafana-ui/src/components/PluginSignatureBadge/PluginSignatureBadge.story.tsx
View File

@ -6,6 +6,8 @@ import { PluginSignatureBadge } from '@grafana/ui';
import { withCenteredStory } from '../../utils/storybook/withCenteredStory';
import mdx from './PluginSignatureBadge.mdx';
export default {
title: 'Data Display/PluginSignatureBadge',
decorators: [withCenteredStory],
@ -24,6 +26,11 @@ export default {
],
},
},
parameters: {
docs: {
page: mdx,
},
},
};
export const Basic: Story = (args) => {