Add Vega help link to DocLinksService #87721

gtback · 2021-01-07T19:23:31Z

Summary

This link is currently wrong, but I'm testing to make sure it will get
caught if it's included in this file. A future commit will actually use
this variables in vega_help_menu.tsx, and update the link in
doc_links_service.ts to be correct.

Fixes #87367
Related: elastic/docs#1805

Checklist

Delete any items that are not applicable to this PR.

For maintainers

This was checked for breaking API changes and was labeled appropriately

This link is currently wrong, but I'm testing to make sure it will get caught if it's included in this file. A future commit will actually use this variables in vega_help_menu.tsx, and update the link in `doc_links_service.ts` to be correct. This is part of a fix for elastic#87367 Related: elastic/docs#1805

elasticmachine · 2021-01-07T19:28:03Z

Pinging @elastic/kibana-docs (Team:Docs)

wylieconlon · 2021-01-07T19:28:02Z

src/core/public/doc_links/doc_links_service.ts

@@ -167,6 +167,7 @@ export class DocLinksService {
          timelionDeprecation: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/dashboard.html#timelion-deprecation`,
          lens: `${ELASTIC_WEBSITE_URL}what-is/kibana-lens`,
          maps: `${ELASTIC_WEBSITE_URL}maps`,
+          vega: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/vega-graph.html`,


This URL doesn't exist any more. Try https://www.elastic.co/guide/en/kibana/7.10/vega-reference.html instead

Yep, that's the point of (the first commit in) this PR. I wanted to make sure the docs build failed, before I replaced it with the correct URL.

Unfortunately, the build passed 😞 . Looks like I have some more work to do on the docs side.

I should have read it more closely!

It looks like, starting in 7.11, the page is now called just vega.html.

lcawl · 2021-01-07T21:59:54Z

@elasticmachine merge upstream

joshdover · 2021-03-10T12:57:58Z

@elasticmachine merge upstream

This file's presence may have prevented checking the broken link I meant to add in this PR.

gtback · 2021-03-10T17:15:15Z

The build finally failed, and for the right reason:

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

Note the en/kibana/master/vega-graph.html path in that output. The rest of the errors are the ones @pgayvallet found in #94274.

The failure is being ignored because kibana-bot doesn't consider these docs_link files to be "docs" changes.

gtback · 2021-03-10T22:15:15Z

@elasticmachine run elasticsearch-ci/docs

gtback · 2021-03-18T15:41:18Z

This is now failing for the right reason:

09:57:27 INFO:build_docs:Bad cross-document links:
09:57:27 INFO:build_docs:  Kibana [master]: src/core/public/doc_links/doc_links_service.ts contains broken links to:
09:57:27 INFO:build_docs:   - en/kibana/master/vega-graph.html

I'll make an update that fixes the link and references it from the correct place.

@spalger I noticed the bot is still letting this pass, even though src/core/public/doc_links/doc_links_service.ts is modified.

elasticsearch-ci/docs failure ignored because this PR doesn't contain docs

gtback · 2021-03-22T15:34:11Z

@elasticmachine merge upstream

gtback · 2021-03-22T15:36:31Z

@pgayvallet Can you let me know if the changes I made in 6cbb0c7 are the right way to pass the DocLinksService into where I can fetch the correct URL?

Also, given how out of date this PR is, I'm not sure if the version labels are correct. Should this still go to 7.12.0, or 7.13.0 (and 7.12.1)?

pgayvallet

@gtback implem looks good to me

Also, given how out of date this PR is, I'm not sure if the version labels are correct. Should this still go to 7.12.0, or 7.13.0 (and 7.12.1)?

7.13 for sure. Not sure if we need to backport to 7.12.1?

gtback · 2021-03-25T13:51:13Z

@elasticmachine merge upstream

kibanamachine · 2021-03-25T16:04:27Z

💚 Build Succeeded

Metrics [docs]

Async chunks

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

id	before	after	diff
`visTypeVega`	2.6MB	2.6MB	-22.0B

Page load bundle

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

id	before	after	diff
`core`	412.1KB	412.2KB	+75.0B
`visTypeVega`	53.7KB	54.0KB	+309.0B
total			+384.0B

History

💚 Build #114351 succeeded 5d54898
💛 Build #113986 was flaky 5c7edfe
💔 Build #112532 failed c2d28ab
💚 Build #112444 succeeded 3ccac78
💚 Build #97724 succeeded 692ac4c

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

wylieconlon

I haven't run this code, but it looks safe to me. This was a common pattern for a few months.

wylieconlon · 2021-03-25T21:03:15Z

src/plugins/vis_type_vega/public/services.ts

@@ -35,3 +35,5 @@ export const [getInjectedVars, setInjectedVars] = createGetterSetter<{
 }>('InjectedVars');

 export const getEnableExternalUrls = () => getInjectedVars().enableExternalUrls;
+
+export const [getDocLinks, setDocLinks] = createGetterSetter<DocLinksStart>('docLinks');


Using createGetterSetter is a bit of an outdated pattern, but I have no objection to following the Vega pattern until we actually refactor this.

cc @alexwizp for refactoring the Vega setup code

kibanamachine · 2021-03-29T22:05:54Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 87721 or prevent reminders by adding the backport:skip label.

kibanamachine · 2021-03-30T22:15:53Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 87721 or prevent reminders by adding the backport:skip label.

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Greg Back <1045796+gtback@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

gtback requested review from KOTungseth and a team January 7, 2021 19:23

gtback requested a review from a team as a code owner January 7, 2021 19:23

lcawl added release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.12.0 v8.0.0 labels Jan 7, 2021

wylieconlon reviewed Jan 7, 2021

View reviewed changes

Merge branch 'master' into gtback/test-doc-link-checker

692ac4c

gtback mentioned this pull request Jan 15, 2021

Kibana link checking is broken elastic/docs#1805

Closed

kibanamachine and others added 3 commits March 10, 2021 07:58

Merge branch 'master' into gtback/test-doc-link-checker

3ccac78

Merge branch 'master' into gtback/test-doc-link-checker

e2bf6c5

Remove legacy doc link file.

c2d28ab

This file's presence may have prevented checking the broken link I meant to add in this PR.

Merge branch 'master' into gtback/test-doc-link-checker

5c7edfe

Update Vega link and pass via DocLinksService

6cbb0c7

Merge branch 'master' into gtback/test-doc-link-checker

5d54898

pgayvallet approved these changes Mar 25, 2021

View reviewed changes

gtback added v7.13.0 and removed v7.12.0 labels Mar 25, 2021

Merge branch 'master' into gtback/test-doc-link-checker

6aee757

KOTungseth approved these changes Mar 25, 2021

View reviewed changes

gtback requested review from a team and wylieconlon March 25, 2021 19:24

wylieconlon approved these changes Mar 25, 2021

View reviewed changes

gtback merged commit e01f317 into elastic:master Mar 25, 2021

gtback deleted the gtback/test-doc-link-checker branch March 25, 2021 21:57

stratoula mentioned this pull request Mar 29, 2021

404 error when clicking on Kibana Vega Help button #95502

Closed

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 29, 2021

stratoula pushed a commit to stratoula/kibana that referenced this pull request Mar 31, 2021

Add Vega help link to DocLinksService (elastic#87721)

1365e3e

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

stratoula mentioned this pull request Mar 31, 2021

[7.x] Add Vega help link to DocLinksService (#87721) #95886

Merged

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 31, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Vega help link to DocLinksService #87721

Add Vega help link to DocLinksService #87721

gtback commented Jan 7, 2021 •

edited

Loading

elasticmachine commented Jan 7, 2021

wylieconlon Jan 7, 2021

gtback Jan 7, 2021

wylieconlon Jan 7, 2021 •

edited

Loading

gtback Mar 22, 2021

lcawl commented Jan 7, 2021

joshdover commented Mar 10, 2021

gtback commented Mar 10, 2021

gtback commented Mar 10, 2021

gtback commented Mar 18, 2021

gtback commented Mar 22, 2021

gtback commented Mar 22, 2021

pgayvallet left a comment

gtback commented Mar 25, 2021

kibanamachine commented Mar 25, 2021

wylieconlon left a comment

wylieconlon Mar 25, 2021

kibanamachine commented Mar 29, 2021

kibanamachine commented Mar 30, 2021

Add Vega help link to DocLinksService #87721

Add Vega help link to DocLinksService #87721

Conversation

gtback commented Jan 7, 2021 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Jan 7, 2021

wylieconlon Jan 7, 2021

Choose a reason for hiding this comment

gtback Jan 7, 2021

Choose a reason for hiding this comment

wylieconlon Jan 7, 2021 • edited Loading

Choose a reason for hiding this comment

gtback Mar 22, 2021

Choose a reason for hiding this comment

lcawl commented Jan 7, 2021

joshdover commented Mar 10, 2021

gtback commented Mar 10, 2021

gtback commented Mar 10, 2021

gtback commented Mar 18, 2021

gtback commented Mar 22, 2021

gtback commented Mar 22, 2021

pgayvallet left a comment

Choose a reason for hiding this comment

gtback commented Mar 25, 2021

kibanamachine commented Mar 25, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

wylieconlon left a comment

Choose a reason for hiding this comment

wylieconlon Mar 25, 2021

Choose a reason for hiding this comment

kibanamachine commented Mar 29, 2021

kibanamachine commented Mar 30, 2021

gtback commented Jan 7, 2021 •

edited

Loading

wylieconlon Jan 7, 2021 •

edited

Loading