SupportSnapshots: Rename to "Get help" (#55206)

This commit is contained in:
Ryan McKinley
2022-09-16 08:51:14 -07:00
committed by GitHub
parent 6539ae512c
commit 0c4d181d1e
12 changed files with 49 additions and 31 deletions

View File

@@ -6,7 +6,7 @@ import { getPanelPlugin } from 'app/features/plugins/__mocks__/pluginMocks';
import { PanelModel } from '../../state/PanelModel';
import { SupportSnapshot } from './SupportSnapshot';
import { HelpWizard } from './HelpWizard';
function setup() {
const panel = new PanelModel({});
@@ -26,7 +26,7 @@ function setup() {
});
panel.getQueryRunner().resendLastResult();
return render(<SupportSnapshot panel={panel} onClose={() => {}} plugin={panel.plugin} />);
return render(<HelpWizard panel={panel} onClose={() => {}} plugin={panel.plugin} />);
}
describe('SupportSnapshot', () => {
it('Can render', async () => {

View File

@@ -20,6 +20,7 @@ import {
Select,
ClipboardButton,
Stack,
Icon,
} from '@grafana/ui';
import { contextSrv } from 'app/core/services/context_srv';
import { PanelModel } from 'app/features/dashboard/state';
@@ -32,7 +33,7 @@ interface Props {
onClose: () => void;
}
export function SupportSnapshot({ panel, plugin, onClose }: Props) {
export function HelpWizard({ panel, plugin, onClose }: Props) {
const styles = useStyles2(getStyles);
const service = useMemo(() => new SupportSnapshotService(panel), [panel]);
@@ -65,25 +66,33 @@ export function SupportSnapshot({ panel, plugin, onClose }: Props) {
}
const tabs = [
{ label: 'Support', value: SnapshotTab.Support },
{ label: 'Snapshot', value: SnapshotTab.Support },
{ label: 'Data', value: SnapshotTab.Data },
];
return (
<Drawer
title={`Support snapshot`}
title={`Get help with this panel`}
width="90%"
onClose={onClose}
expandable
scrollableContent
subtitle={
<Stack direction="column" gap={1}>
<span>
<Stack direction="row" gap={1}>
<FeatureBadge featureState={FeatureState.beta} />
</span>
<a
href="https://grafana.com/docs/grafana/latest/troubleshooting/"
target="blank"
className="external-link"
rel="noopener noreferrer"
>
Troubleshooting docs <Icon name="external-link-alt" />
</a>
</Stack>
<span className="muted">
A support snapshot contains the query response data and raw panel settings. Include this snapshot in support
requests to help identify issues faster
To request troubleshooting help, send a snapshot of this panel to Grafana Labs Technical Support. The
snapshot contains query response data and panel settings.
</span>
</Stack>
}

View File

@@ -10,8 +10,8 @@ import { getPanelStateForModel } from 'app/features/panel/state/selectors';
import { StoreState } from 'app/types';
import { GetDataOptions } from '../../../query/state/PanelQueryRunner';
import { HelpWizard } from '../HelpWizard/HelpWizard';
import { usePanelLatestData } from '../PanelEditor/usePanelLatestData';
import { SupportSnapshot } from '../SupportSnapshot/SupportSnapshot';
import { InspectContent } from './InspectContent';
import { useDatasourceMetadata, useInspectTabs } from './hooks';
@@ -50,8 +50,8 @@ const PanelInspectorUnconnected = ({ panel, dashboard, plugin }: Props) => {
return null;
}
if (defaultTab === InspectTab.Support) {
return <SupportSnapshot panel={panel} plugin={plugin} onClose={onClose} />;
if (defaultTab === InspectTab.Help) {
return <HelpWizard panel={panel} plugin={plugin} onClose={onClose} />;
}
return (