remove legacy doc links file #94274

pgayvallet · 2021-03-10T10:42:48Z

Summary

Remove the legacy doc link stub file we added in #76354 as elastic/docs#1953 added lookup from core's src/core/public/doc_links/doc_links_service.ts

elasticmachine · 2021-03-10T10:43:18Z

Pinging @elastic/kibana-core (Team:Core)

pgayvallet · 2021-03-10T10:50:35Z

@elastic/kibana-docs can you confirm that the elasticsearch-ci/docs job will be alright with this change?

The failure ignored because this PR doesn't contain docs message on the job scares me.

lcawl

LGTM

pgayvallet · 2021-03-11T10:40:37Z

This PR is currently blocked because removing the legacy doc file actually cause the doc build validation script to correctly uses core's docLink service (which was never the case until now), revealing a few issues:

It seems like there are three types of broken links in docs_links_service.ts:

Links that start with ${ELASTIC_WEBSITE_URL} but go to places other than the docs (like blog pages or marketing pages). We can’t check these links as part of the docs build, so we should ignore these. I’ll work on a change in elastic/docs.

Links to the enterprise-search docs. These don’t work because we don’t publish the master branch of those docs. I’m not sure what to do with these.

Actual broken links to things under en/kibana which should be fixed

Currently broken links are:

06:44:04 INFO:build_docs:  Kibana [master]: src/core/public/doc_links/doc_links_service.ts contains broken links to:
06:44:04 INFO:build_docs:   - ${ELASTIC_WEBSITE_URL}blog/external-collection-for-elastic-stack-monitoring-is-now-available-via-metricbeat
06:44:04 INFO:build_docs:   - ${ELASTIC_WEBSITE_URL}maps
06:44:04 INFO:build_docs:   - ${ELASTIC_WEBSITE_URL}what-is/kibana-lens
06:44:04 INFO:build_docs:   - en/app-search/master
06:44:04 INFO:build_docs:   - en/enterprise-search/master
06:44:04 INFO:build_docs:   - en/kibana/master/alert-type-index-threshold.html#index-action-configuration
06:44:04 INFO:build_docs:   - en/kibana/master/tutorial-load-dataset.html
06:44:04 INFO:build_docs:   - en/workplace-search/master

Links from category 3, which need actual fixing from the docLink definition, are:

06:44:04 INFO:build_docs:   - en/kibana/master/alert-type-index-threshold.html#index-action-configuration
06:44:04 INFO:build_docs:   - en/kibana/master/tutorial-load-dataset.html

cc @gtback

pgayvallet · 2021-03-11T10:51:46Z

en/kibana/master/tutorial-load-dataset.html

This one is indexPatterns.loadingData

kibana/src/core/public/doc_links/doc_links_service.ts

Line 123 in a102fa9

    
           loadingData: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/tutorial-load-dataset.html`,

Link is indeed a 404 on the site. It seems the link is unused in the code base too, so I will just remove it - 0bb1877

en/kibana/master/alert-type-index-threshold.html#index-action-configuration

This one is alerting.indexThreshold

kibana/src/core/public/doc_links/doc_links_service.ts

Line 194 in a102fa9

    
           indexThreshold: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/alert-type-index-threshold.html#index-action-configuration`,

used here:

kibana/x-pack/plugins/stack_alerts/public/alert_types/threshold/index.ts

Line 21 in a102fa9

documentationUrl: (docLinks) => docLinks.links.alerting.indexThreshold,

cc @elastic/kibana-alerting-services Do you mind fixing that one, or telling me what to replace the target with?

EDIT: it seems https://www.elastic.co/guide/en/kibana/master/alert-type-index-threshold.html#index-action-configuration do exist, but the anchor (#index-action-configuration) is not found on the page. Should we just remove it?

Removed the anchor - b77eb21

ymao1 · 2021-03-11T18:33:23Z

EDIT: it seems https://www.elastic.co/guide/en/kibana/master/alert-type-index-threshold.html#index-action-configuration do exist, but the anchor (#index-action-configuration) is not found on the page. Should we just remove it?

Yes, it should be fine to remove just the anchor.

…gacy-doc-link

pgayvallet · 2021-03-15T08:08:18Z

@gtback I fixed the two link that were targeting Kibana docs.

Could you please check the CI doc build job to confirm that there are no more link from the Actual broken links to things under en/kibana which should be fixed category?

Do you also have any visibility on when the team will be able to fix the two other categories?

gtback · 2021-03-17T12:03:33Z

@elasticmachine merge upstream

gtback · 2021-03-17T12:29:16Z

@pgayvallet these are the remaining broken links:

08:12:36 INFO:build_docs:  Kibana [master]: src/core/public/doc_links/doc_links_service.ts contains broken links to:
08:12:36 INFO:build_docs:   - en/elasticsearch/reference/master/search-aggregations.html#_values_source
08:12:36 INFO:build_docs:   - en/kibana/master/alert-type-es-query.html
08:12:36 INFO:build_docs:   - en/kibana/master/alert-type-index-threshold.html
08:12:36 INFO:build_docs:   - en/kibana/master/pre-configured-action-types-and-connectors.html

pgayvallet · 2021-03-17T13:17:53Z

08:12:36 INFO:build_docs:   - en/elasticsearch/reference/master/search-aggregations.html#_values_source

scriptedFields.scriptAggs. Invalid anchor, will remove it

08:12:36 INFO:build_docs:   - en/kibana/master/alert-type-es-query.html

alerting.esQuery

08:12:36 INFO:build_docs:   - en/kibana/master/alert-type-index-threshold.html

alerting.indexThreshold

08:12:36 INFO:build_docs:   - en/kibana/master/pre-configured-action-types-and-connectors.html

alerting.preconfiguredConnectors

These 3 are redirecting to real 404 though. @elastic/kibana-alerting-services Could you take a look and tell me what the correct urls would be?

ymao1 · 2021-03-17T13:24:15Z

These 3 are redirecting to real 404 though. @elastic/kibana-alerting-services Could you take a look and tell me what the correct urls would be?

Those were changed as part of the terminology update PR. Sorry for not updating them in that PR!

en/kibana/master/alert-type-es-query.html -> en/kibana/master/rule-type-es-query.html
en/kibana/master/alert-type-index-threshold.html -> en/kibana/master/rule-type-index-threshold.html
en/kibana/master/pre-configured-action-types-and-connectors.html -> en/kibana/master/pre-configured-connectors.html

…gacy-doc-link

kibanamachine · 2021-03-17T21:03:11Z

💚 Build Succeeded

Metrics [docs]

Page load bundle

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

id	before	after	diff
`core`	433.5KB	433.4KB	-160.0B

History

💚 Build #113648 succeeded e8bce0f
💔 Build #113608 failed c46074f4ebbc236ab576d4c01ba9e9e13c4e98aa
💔 Build #113003 failed 8818cd8
💔 Build #112709 failed 0bb1877
💚 Build #112422 succeeded c5e1ed6

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

* remove legacy doc links file * remove entry from watch paths * remove unused invalid link * fix alerting.indexThreshold link * fix more links * update generated doc * update generated doc

* remove legacy doc links file (#94274) * remove legacy doc links file * remove entry from watch paths * remove unused invalid link * fix alerting.indexThreshold link * fix more links * update generated doc * update generated doc * update generated doc

remove legacy doc links file

9adc4a4

pgayvallet added chore release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v7.13.0 labels Mar 10, 2021

pgayvallet requested review from a team March 10, 2021 10:43

remove entry from watch paths

c5e1ed6

pgayvallet requested a review from a team as a code owner March 10, 2021 11:37

joshdover approved these changes Mar 10, 2021

View reviewed changes

lcawl approved these changes Mar 10, 2021

View reviewed changes

gtback mentioned this pull request Mar 10, 2021

Add Vega help link to DocLinksService #87721

Merged

1 task

remove unused invalid link

0bb1877

pgayvallet added 2 commits March 15, 2021 09:05

fix alerting.indexThreshold link

b77eb21

Merge remote-tracking branch 'upstream/master' into kbn-xxx-remove-le…

8818cd8

…gacy-doc-link

jbudz approved these changes Mar 15, 2021

View reviewed changes

This was referenced Mar 16, 2021

Skip checking Kibana links that are on www.elastic.co but not docs links elastic/docs#2081

Closed

Kibana link checking is broken elastic/docs#1805

Closed

Improve link extraction for Kibana link checking elastic/docs#2085

Merged

pgayvallet added 3 commits March 17, 2021 14:54

Merge remote-tracking branch 'upstream/master' into kbn-xxx-remove-le…

280d677

…gacy-doc-link

fix more links

2a15c2f

update generated doc

e8bce0f

pgayvallet force-pushed the kbn-xxx-remove-legacy-doc-link branch from c46074f to e8bce0f Compare March 17, 2021 13:59

pgayvallet added 3 commits March 17, 2021 15:31

Merge remote-tracking branch 'upstream/master' into kbn-xxx-remove-le…

36c355f

…gacy-doc-link

update generated doc

d82bacb

Merge remote-tracking branch 'upstream/master' into kbn-xxx-remove-le…

abd7558

…gacy-doc-link

pgayvallet merged commit 5669fac into elastic:master Mar 17, 2021

pgayvallet mentioned this pull request Mar 17, 2021

[7.x] remove legacy doc links file (#94274) #94863

Merged

gtback mentioned this pull request Jan 27, 2022

add new path for kibana links check elastic/docs#2360

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

remove legacy doc links file #94274

remove legacy doc links file #94274

pgayvallet commented Mar 10, 2021 •

edited

Loading

elasticmachine commented Mar 10, 2021

pgayvallet commented Mar 10, 2021 •

edited

Loading

lcawl left a comment

pgayvallet commented Mar 11, 2021

pgayvallet commented Mar 11, 2021 •

edited

Loading

ymao1 commented Mar 11, 2021

pgayvallet commented Mar 15, 2021

gtback commented Mar 17, 2021

gtback commented Mar 17, 2021

pgayvallet commented Mar 17, 2021

ymao1 commented Mar 17, 2021

kibanamachine commented Mar 17, 2021

remove legacy doc links file #94274

remove legacy doc links file #94274

Conversation

pgayvallet commented Mar 10, 2021 • edited Loading

Summary

elasticmachine commented Mar 10, 2021

pgayvallet commented Mar 10, 2021 • edited Loading

lcawl left a comment

Choose a reason for hiding this comment

pgayvallet commented Mar 11, 2021

pgayvallet commented Mar 11, 2021 • edited Loading

en/kibana/master/tutorial-load-dataset.html

en/kibana/master/alert-type-index-threshold.html#index-action-configuration

ymao1 commented Mar 11, 2021

pgayvallet commented Mar 15, 2021

gtback commented Mar 17, 2021

gtback commented Mar 17, 2021

pgayvallet commented Mar 17, 2021

ymao1 commented Mar 17, 2021

kibanamachine commented Mar 17, 2021

💚 Build Succeeded

Metrics [docs]

Page load bundle

History

pgayvallet commented Mar 10, 2021 •

edited

Loading

pgayvallet commented Mar 10, 2021 •

edited

Loading

pgayvallet commented Mar 11, 2021 •

edited

Loading