Use documentation link service for snapshot restore #91596

lcawl · 2021-02-17T00:51:21Z

Summary

Related to #88107

This PR replaces hard-coded links with keywords from the documentation link service.

It also fixes some links (e.g. replacing occurrences of https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put.html with https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put-policy.html)

In the long run, I think https://github.com/elastic/kibana/blob/master/x-pack/plugins/snapshot_restore/public/application/services/documentation/documentation_links.ts should be removed and the documentation link service should be called directly from the app's pages.
[This has been accomplished in the commits @alisonelizabeth added].

Screenshot

The links are used in the Snapshot and Restore UI in places like this:

...ck/plugins/snapshot_restore/public/application/services/documentation/documentation_links.ts

lcawl · 2021-02-18T18:38:41Z

@elasticmachine merge upstream

kibanamachine · 2021-02-18T18:38:43Z

merge conflict between base and head

alisonelizabeth

Thanks for working on this @lcawl!

In the long run, I think https://github.com/elastic/kibana/blob/master/x-pack/plugins/snapshot_restore/public/application/services/documentation/documentation_links.ts should be removed and the documentation link service should be called directly from the app's pages.

I agree with this. I went ahead and opened a PR against your branch with these changes: lcawl#2. If you're comfortable with the changes, you can go ahead and merge it into your branch and I will review again.

lcawl · 2021-02-18T19:03:48Z

If you're comfortable with the changes, you can go ahead and merge it into your branch and I will review again.

That's great, thanks! I'll just address the merge conflicts, then merge.

Merge pull request #2 from alisonelizabeth/suggested_changes

alisonelizabeth

Latest LGTM. I left one nit and also a suggestion about changing the cron documentation link, but nothing blocking.

alisonelizabeth · 2021-02-19T14:08:52Z

.../plugins/snapshot_restore/public/application/components/policy_form/steps/step_logistics.tsx

@@ -420,7 +417,7 @@ export const PolicyStepLogistics: React.FunctionComponent<StepProps> = ({
                defaultMessage="Use cron expression. {docLink}"
                values={{
                  docLink: (
-                    <EuiLink href={documentationLinksService.getCronUrl()} target="_blank">
+                    <EuiLink href={docLinks.links.watcher.cronSchedule} target="_blank">


For SLM, I think it might make more sense to point to these docs https://www.elastic.co/guide/en/elasticsearch/reference/current/cron-expressions.html rather than watcher.

Thanks, I've changed that URL

x-pack/plugins/snapshot_restore/public/application/lib/type_to_doc_url.ts

elasticmachine · 2021-02-19T14:15:44Z

Pinging @elastic/es-ui (Team:Elasticsearch UI)

…_doc_url.ts Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>

lukeelmers · 2021-02-19T16:57:03Z

src/core/public/doc_links/doc_links_service.ts

@@ -126,6 +127,8 @@ export class DocLinksService {
        addData: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/connect-to-elasticsearch.html`,
        kibana: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/index.html`,
        elasticsearch: {
+          dateMathIndexNames: `${ELASTICSEARCH_DOCS}date-math-index-names.html`,


nit: Could alternatively live under date with the other dateMath link, but no strong feelings on this one way or the other.

Thanks, I'll make that change!

kibanamachine · 2021-02-19T19:24:39Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`snapshotRestore`	178	177	-1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`snapshotRestore`	481.9KB	480.7KB	-1.3KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`core`	477.4KB	478.6KB	+1.2KB
`snapshotRestore`	60.0KB	59.2KB	-800.0B
total			+441.0B

History

💚 Build #108069 succeeded ce26b3f
💚 Build #108014 succeeded 7d7eecd
💔 Build #107851 failed 4dc4aa6
💚 Build #107784 succeeded 7bf27fc
💚 Build #107543 succeeded befb48b

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>

Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com> Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>

…ndition-for-hiding-recommded-allocation * 'master' of github.com:elastic/kibana: (117 commits) [coverage] ingest data in parallel (elastic#92074) [Lens] Drag and drop performance improvements (elastic#91641) A few more environment uiFilters fixes (elastic#92044) Enabling Uptime and Dashboard a11y test (elastic#91017) [Security Solution][Detections] Adds more granular validation for nested fields (elastic#92041) [Security Solution] [Detections] add overflow-wrap for description (elastic#91945) [Security Solution] [Detections] do not truncate filename in value list table in modal (elastic#91952) Skip flaky apm test elastic#91673 (elastic#92065) [docker] Default server.name to hostname (elastic#90799) Use documentation link service for snapshot restore (elastic#91596) [Security Solution] Clearing up all jest errors and warnings (elastic#91740) Add `@kbn/analytics` to UI Shared Deps (elastic#91810) [7.12][Telemetry] Add missing fields for security telemetry (elastic#91920) [Security Solution] Adds cypress-pipe (elastic#91550) [ML] Fix event rate chart annotation position (elastic#91899) [APM] Break down error table api removing the sparklines (elastic#89138) docs: update dependencies table bug (elastic#91964) [Time to Visualize] Stay in Edit Mode After Dashboard Quicksave (elastic#91729) Unskip Search Sessions Management UI test (elastic#90110) [Fleet] Handle long text in agent details page (elastic#91776) ... # Conflicts: # x-pack/plugins/index_lifecycle_management/__jest__/client_integration/edit_policy/edit_policy.helpers.tsx # x-pack/plugins/index_lifecycle_management/__jest__/components/edit_policy.test.tsx

…bana into task-manager/docs-monitoring * 'task-manager/docs-monitoring' of github.com:gmmorris/kibana: (29 commits) Update docs/developer/plugin-list.asciidoc Update docs/api/task-manager/health.asciidoc Update docs/api/task-manager/health.asciidoc [Lens] Load indexpatterns list from indexPattern Service (elastic#91984) [coverage] ingest data in parallel (elastic#92074) [Lens] Drag and drop performance improvements (elastic#91641) A few more environment uiFilters fixes (elastic#92044) Enabling Uptime and Dashboard a11y test (elastic#91017) [Security Solution][Detections] Adds more granular validation for nested fields (elastic#92041) [Security Solution] [Detections] add overflow-wrap for description (elastic#91945) [Security Solution] [Detections] do not truncate filename in value list table in modal (elastic#91952) Skip flaky apm test elastic#91673 (elastic#92065) [docker] Default server.name to hostname (elastic#90799) Use documentation link service for snapshot restore (elastic#91596) [Security Solution] Clearing up all jest errors and warnings (elastic#91740) Add `@kbn/analytics` to UI Shared Deps (elastic#91810) [7.12][Telemetry] Add missing fields for security telemetry (elastic#91920) [Security Solution] Adds cypress-pipe (elastic#91550) [ML] Fix event rate chart annotation position (elastic#91899) [APM] Break down error table api removing the sparklines (elastic#89138) ...

* master: (36 commits) [Uptime] Thumbnail full screen view steps navigation fix (elastic#91895) Implement ScopedHistory.block (elastic#91099) [Lens] Fix overlowing content on a chart for charts and table (elastic#92006) handle source column differences in embeddable as well (elastic#91987) [Vega] [Map] disable map rotation using right right click / touch rotation gesture (elastic#91996) [Lens] Load indexpatterns list from indexPattern Service (elastic#91984) [coverage] ingest data in parallel (elastic#92074) [Lens] Drag and drop performance improvements (elastic#91641) A few more environment uiFilters fixes (elastic#92044) Enabling Uptime and Dashboard a11y test (elastic#91017) [Security Solution][Detections] Adds more granular validation for nested fields (elastic#92041) [Security Solution] [Detections] add overflow-wrap for description (elastic#91945) [Security Solution] [Detections] do not truncate filename in value list table in modal (elastic#91952) Skip flaky apm test elastic#91673 (elastic#92065) [docker] Default server.name to hostname (elastic#90799) Use documentation link service for snapshot restore (elastic#91596) [Security Solution] Clearing up all jest errors and warnings (elastic#91740) Add `@kbn/analytics` to UI Shared Deps (elastic#91810) [7.12][Telemetry] Add missing fields for security telemetry (elastic#91920) [Security Solution] Adds cypress-pipe (elastic#91550) ...

lcawl mentioned this pull request Feb 17, 2021

Move from hard-coded links to documentation link service #88107

Closed

lcawl commented Feb 17, 2021

View reviewed changes

...ck/plugins/snapshot_restore/public/application/services/documentation/documentation_links.ts Outdated Show resolved Hide resolved

lcawl force-pushed the restore-doc-links branch from 612b22e to c395384 Compare February 17, 2021 21:39

lcawl marked this pull request as ready for review February 17, 2021 22:25

lcawl requested review from a team as code owners February 17, 2021 22:25

lcawl added Feature:Snapshot and Restore Elasticsearch snapshots and repositories UI release_note:skip Skip the PR/issue when compiling release notes v8.0.0 docs v7.13.0 labels Feb 17, 2021

elastic deleted a comment from kibanamachine Feb 18, 2021

alisonelizabeth reviewed Feb 18, 2021

View reviewed changes

lcawl added 2 commits February 18, 2021 10:53

Use documentation link service for snapshot restore

b53ac32

Adds docLinksServiceMock for jest test

7bf27fc

lcawl force-pushed the restore-doc-links branch from befb48b to 7bf27fc Compare February 18, 2021 18:59

lcawl and others added 4 commits February 18, 2021 13:26

Use documentation link service for snapshot restore

ccc22c3

remove doc service

6a7f233

Remove doc service

4dc4aa6

Merge pull request #2 from alisonelizabeth/suggested_changes

fix tests

7d7eecd

alisonelizabeth approved these changes Feb 19, 2021

View reviewed changes

alisonelizabeth added the Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more label Feb 19, 2021

lcawl and others added 2 commits February 19, 2021 08:38

Update x-pack/plugins/snapshot_restore/public/application/lib/type_to…

ce26b3f

…_doc_url.ts Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>

Changes cron link

7f2bd35

lukeelmers approved these changes Feb 19, 2021

View reviewed changes

Changes date math link

05c0729

lcawl merged commit a6a567f into elastic:master Feb 19, 2021

lcawl deleted the restore-doc-links branch February 19, 2021 19:56

lcawl added a commit to lcawl/kibana that referenced this pull request Feb 19, 2021

Use documentation link service for snapshot restore (elastic#91596)

8ff9aac

Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>

lcawl mentioned this pull request Feb 19, 2021

[7.x] Use documentation link service for snapshot restore (#91596) #92079

Merged

lcawl added a commit that referenced this pull request Feb 19, 2021

Use documentation link service for snapshot restore (#91596) (#92079)

c58df46

Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com> Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use documentation link service for snapshot restore #91596

Use documentation link service for snapshot restore #91596

lcawl commented Feb 17, 2021 •

edited

Loading

lcawl commented Feb 18, 2021

kibanamachine commented Feb 18, 2021

alisonelizabeth left a comment

lcawl commented Feb 18, 2021

alisonelizabeth left a comment

alisonelizabeth Feb 19, 2021

lcawl Feb 19, 2021

elasticmachine commented Feb 19, 2021

lukeelmers Feb 19, 2021

lcawl Feb 19, 2021

kibanamachine commented Feb 19, 2021

Use documentation link service for snapshot restore #91596

Use documentation link service for snapshot restore #91596

Conversation

lcawl commented Feb 17, 2021 • edited Loading

Summary

Screenshot

lcawl commented Feb 18, 2021

kibanamachine commented Feb 18, 2021

alisonelizabeth left a comment

Choose a reason for hiding this comment

lcawl commented Feb 18, 2021

alisonelizabeth left a comment

Choose a reason for hiding this comment

alisonelizabeth Feb 19, 2021

Choose a reason for hiding this comment

lcawl Feb 19, 2021

Choose a reason for hiding this comment

elasticmachine commented Feb 19, 2021

lukeelmers Feb 19, 2021

Choose a reason for hiding this comment

lcawl Feb 19, 2021

Choose a reason for hiding this comment

kibanamachine commented Feb 19, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

lcawl commented Feb 17, 2021 •

edited

Loading