Skip to content

Commit dffd631

Browse files
[DOCS] Edits copy in Reporting Diagnostics tool (#77833)
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
1 parent aa9131f commit dffd631

File tree

3 files changed

+20
-18
lines changed

3 files changed

+20
-18
lines changed

docs/user/reporting/reporting-troubleshooting.asciidoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,11 @@ Having trouble? Here are solutions to common problems you might encounter while
1818

1919
[float]
2020
[[reporting-diagnostics]]
21-
=== Reporting Diagnostics
22-
Reporting comes with a built-in utility to try to automatically find common issues. When Kibana is running, navigate to the Report Listing page, and click the "Run reporting diagnostics..." button. This will open up a diagnostic tool that checks various parts of the Kibana deployment to come up with any relevant recommendations.
21+
=== Reporting diagnostics
22+
Reporting comes with a built-in utility to try to automatically find common issues.
23+
When {kib} is running, navigate to the Report Listing page, and click *Run reporting diagnostics*.
24+
This will open up a diagnostic tool that checks various parts of the {kib} deployment and
25+
come up with any relevant recommendations.
2326

2427
[float]
2528
[[reporting-troubleshooting-system-dependencies]]

x-pack/plugins/reporting/public/components/report_diagnostic.tsx

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,13 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
107107
const steps = [
108108
{
109109
title: i18n.translate('xpack.reporting.listing.diagnosticConfigTitle', {
110-
defaultMessage: 'Verify Kibana Configuration',
110+
defaultMessage: 'Verify Kibana configuration',
111111
}),
112112
children: (
113113
<Fragment>
114114
<FormattedMessage
115115
id="xpack.reporting.listing.diagnosticConfigMessage"
116-
defaultMessage="This check ensures your Kibana configuration is setup properly for reports."
116+
defaultMessage="Ensure your Kibana configuration is properly set up for reports."
117117
/>
118118
<EuiSpacer />
119119
<EuiButton
@@ -124,7 +124,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
124124
>
125125
<FormattedMessage
126126
id="xpack.reporting.listing.diagnosticConfigButton"
127-
defaultMessage="Verify Configuration"
127+
defaultMessage="Verify configuration"
128128
/>
129129
</EuiButton>
130130
</Fragment>
@@ -136,14 +136,13 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
136136
if (configStatus === 'complete') {
137137
steps.push({
138138
title: i18n.translate('xpack.reporting.listing.diagnosticBrowserTitle', {
139-
defaultMessage: 'Check Browser',
139+
defaultMessage: 'Check browser',
140140
}),
141141
children: (
142142
<Fragment>
143143
<FormattedMessage
144144
id="xpack.reporting.listing.diagnosticBrowserMessage"
145-
defaultMessage="Reporting utilizes a headless browser to generate PDF and PNGS. This check validates
146-
that the browser can launch successfully."
145+
defaultMessage="Reporting uses a headless browser to generate PDF and PNGs. Validate that the browser can launch successfully."
147146
/>
148147
<EuiSpacer />
149148
<EuiButton
@@ -154,7 +153,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
154153
>
155154
<FormattedMessage
156155
id="xpack.reporting.listing.diagnosticBrowserButton"
157-
defaultMessage="Check Browser"
156+
defaultMessage="Check browser"
158157
/>
159158
</EuiButton>
160159
</Fragment>
@@ -166,13 +165,13 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
166165
if (chromeStatus === 'complete') {
167166
steps.push({
168167
title: i18n.translate('xpack.reporting.listing.diagnosticScreenshotTitle', {
169-
defaultMessage: 'Check Screen Capture Capabilities',
168+
defaultMessage: 'Check screen capture',
170169
}),
171170
children: (
172171
<Fragment>
173172
<FormattedMessage
174173
id="xpack.reporting.listing.diagnosticScreenshotMessage"
175-
defaultMessage="This check ensures the headless browser can capture a screenshot of a page."
174+
defaultMessage="Ensure that the headless browser can capture a screenshot of a page."
176175
/>
177176
<EuiSpacer />
178177
<EuiButton
@@ -183,7 +182,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
183182
>
184183
<FormattedMessage
185184
id="xpack.reporting.listing.diagnosticScreenshotButton"
186-
defaultMessage="Capture Screenshot"
185+
defaultMessage="Capture screenshot"
187186
/>
188187
</EuiButton>
189188
</Fragment>
@@ -201,7 +200,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
201200
<Fragment>
202201
<FormattedMessage
203202
id="xpack.reporting.listing.diagnosticSuccessMessage"
204-
defaultMessage="Excellent! Everything looks like shipshape for reporting to function!"
203+
defaultMessage="Everything looks good for reporting to function."
205204
/>
206205
</Fragment>
207206
),
@@ -212,7 +211,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
212211
if (!success) {
213212
steps.push({
214213
title: i18n.translate('xpack.reporting.listing.diagnosticFailureTitle', {
215-
defaultMessage: "Whoops! Looks like something isn't working properly.",
214+
defaultMessage: "Something isn't working properly.",
216215
}),
217216
children: (
218217
<Fragment>
@@ -228,7 +227,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
228227
<EuiSpacer />
229228
<FormattedMessage
230229
id="xpack.reporting.listing.diagnosticFailureDescription"
231-
defaultMessage="Here are some more details about the issue:"
230+
defaultMessage="Here are some details about the issue:"
232231
/>
233232
<EuiSpacer />
234233
<EuiCodeBlock>{logs}</EuiCodeBlock>
@@ -257,7 +256,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
257256
<EuiText color="subdued">
258257
<FormattedMessage
259258
id="xpack.reporting.listing.diagnosticDescription"
260-
defaultMessage="Automatically run a series of diagnostics to troubleshoot common reporting problems."
259+
defaultMessage="Run diagnostics to automatically troubleshoot common reporting problems."
261260
/>
262261
</EuiText>
263262
</EuiFlyoutHeader>
@@ -273,7 +272,7 @@ export const ReportDiagnostic = ({ apiClient }: Props) => {
273272
<EuiButtonEmpty size="xs" flush="left" onClick={showFlyout}>
274273
<FormattedMessage
275274
id="xpack.reporting.listing.diagnosticButton"
276-
defaultMessage="Run reporting diagnostics..."
275+
defaultMessage="Run reporting diagnostics"
277276
/>
278277
</EuiButtonEmpty>
279278
</div>

x-pack/plugins/reporting/public/components/report_listing.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ class ReportListingUi extends Component<Props, State> {
154154
<p>
155155
<FormattedMessage
156156
id="xpack.reporting.listing.reports.subtitle"
157-
defaultMessage="Find reports generated in Kibana applications here"
157+
defaultMessage="Get reports generated in Kibana applications."
158158
/>
159159
</p>
160160
</EuiText>

0 commit comments

Comments
 (0)