Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[index pattern field editor] Update runtime field painless docs url #100014

Merged
merged 4 commits into from
May 13, 2021
Merged

[index pattern field editor] Update runtime field painless docs url #100014

merged 4 commits into from
May 13, 2021

Conversation

mattkime
Copy link
Contributor

@mattkime mattkime commented May 13, 2021 •
edited
Loading

Summary

We now have better content to link to when authoring runtime fields. Lets link to it.

@mattkime mattkime changed the title update runtime field painless docs url [index pattern field editor] Update runtime field painless docs url May 13, 2021
@mattkime mattkime added v8.0.0 v7.14.0 v7.13.0 Feature:Data Views Data Views code and UI - index patterns before 8.0 Feature:Kibana Management Feature label for Data Views, Advanced Setting, Saved Object management pages Feature:Runtime Fields Team:AppServices auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes labels May 13, 2021
@mattkime mattkime marked this pull request as ready for review May 13, 2021 16:33
@mattkime mattkime requested a review from a team as a code owner May 13, 2021 16:33
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app-services (Team:AppServices)

@gchaps gchaps requested a review from lcawl May 13, 2021 16:35
@mattkime
Copy link
Contributor Author

@elasticmachine merge upstream

lcawl
lcawl reviewed May 13, 2021
View reviewed changes
src/plugins/index_pattern_field_editor/public/lib/documentation.ts Outdated
const painlessDocsBase = `${docsBase}/elasticsearch/painless/${DOC_LINK_VERSION}`;

return {
runtimePainless: `${esDocsBase}/runtime.html#runtime-mapping-fields`,
runtimePainless: `${docsBase}/kibana/master/managing-index-patterns.html#runtime-fields`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think instead of hard-coding a version in here, it'd be preferrable to define a const instead. For example:

const kibanaDocsBase = ${docsBase}/kibana/${DOC_LINK_VERSION}`;

Then return the URL like this:

runtimePainless: ${kibanaDocsBase}/managing-index-patterns.html#runtime-fields,

@lcawl
Copy link
Contributor

lcawl commented May 13, 2021

FYI: We've been moving to using the doc link service (so that the links are checked as part of our doc build). Somehow this editor was missed from our initial list, so I've added it for cleanup in #88107.

@kibanamachine
Copy link
Contributor

💚 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
indexPatternFieldEditor 82.0KB 82.0KB -9.0B
Unknown metric groups

References to deprecated APIs

id before after diff
canvas 29 25 -4
crossClusterReplication 8 6 -2
fleet 4 2 -2
globalSearch 4 2 -2
indexManagement 12 7 -5
infra 5 3 -2
licensing 18 15 -3
monitoring 109 56 -53
total -73

History

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

lcawl
lcawl approved these changes May 13, 2021
View reviewed changes
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mattkime mattkime merged commit 9d9dfe4 into elastic:master May 13, 2021
@kibanamachine kibanamachine mentioned this pull request May 13, 2021
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request May 13, 2021
@mattkime @kibanamachine
[index pattern field editor] Update runtime field painless docs url (e…
3d4e8f5 
…lastic#100014)

* update runtime field painless docs url
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request May 13, 2021
@mattkime @kibanamachine
[index pattern field editor] Update runtime field painless docs url (e…
c6bb942 
…lastic#100014)

* update runtime field painless docs url
@kibanamachine kibanamachine mentioned this pull request May 13, 2021
Merged
@kibanamachine
Copy link
Contributor

💚 Backport successful

Status Branch Result
✅ 7.13
✅ 7.x

The backport PRs will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request May 13, 2021
@kibanamachine @mattkime
[index pattern field editor] Update runtime field painless docs url (#…
a7374f1 
…100014) (#100084)

* update runtime field painless docs url

Co-authored-by: Matthew Kime <matt@mattki.me>
kibanamachine added a commit that referenced this pull request May 13, 2021
@kibanamachine @mattkime
[index pattern field editor] Update runtime field painless docs url (#…
f27101d 
…100014) (#100083)

* update runtime field painless docs url

Co-authored-by: Matthew Kime <matt@mattki.me>
gmmorris added a commit to chrisronline/kibana that referenced this pull request May 14, 2021
@gmmorris
Merge branch 'master' into pr/97311
44babf8 
* master: (27 commits)
  Disable contextMenu when event is not event.kind=event (elastic#100027)
  Updates the monorepo-packages list (elastic#100096)
  Removes circular deps for lists in tooling and bumps down byte limit for lists (elastic#100082)
  [Security Solutions] Breaks down the io-ts packages to decrease plugin size (elastic#100058)
  fix-typo: Use of `than` instead of `then` (elastic#100030)
  [Fleet] Fix error when searching for keys whose names have spaces (elastic#100056)
  [Workplace Search] Fix bug when transitioning to personal dashboard (elastic#100061)
  [index pattern field editor] Update runtime field painless docs url (elastic#100014)
  [QA] Switch tests to use importExport - visualize (elastic#98063)
  [Canvas] Remove unused legacy autocomplete component (elastic#99215)
  Re-enable formerly flaky shareable test (elastic#98826)
  [Uptime] [Synthetics Integration] ensure that proxy url is not overwritten (elastic#99944)
  [Security Solutions][Lists] Trims down list plugin size by breaking out the exception builder into chunks by using react lazy loading (elastic#99989)
  [Uptime] Increase debounce and add immediate submit to `useQueryBar` (elastic#99675)
  chore(NA): moving @kbn/docs-utils into bazel (elastic#100051)
  [Enterprise Search] Fix SchemaFieldTypeSelect axe issues (elastic#100035)
  Remove outdated comment about schema validation not working (it does work now). (elastic#100055)
  Rename alert status OK to Recovered and fix some UX issues around disabling a rule while being in an error state (elastic#98135)
  [Fleet] Do not use async method in plugin setup|start (elastic#100033)
  Skip flaky functional test suite
  ...
@LeeDr
Copy link
Contributor

LeeDr commented May 14, 2021

Is this updating the link here?
image

And here?
image

Anywhere else?

@mattkime
Copy link
Contributor Author

@LeeDr only the second one. Nowhere else.

@mattkime
Copy link
Contributor Author

I should include a screenshot next time.

yctercero pushed a commit to yctercero/kibana that referenced this pull request May 17, 2021
@mattkime @yctercero
[index pattern field editor] Update runtime field painless docs url (e…
592208f 
…lastic#100014)

* update runtime field painless docs url
yctercero pushed a commit to yctercero/kibana that referenced this pull request May 25, 2021
@mattkime @yctercero
[index pattern field editor] Update runtime field painless docs url (e…
65371d9 
…lastic#100014)

* update runtime field painless docs url
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lcawl lcawl lcawl approved these changes

Assignees
No one assigned
Labels
auto-backport Deprecated - use backport:version if exact versions are needed Feature:Data Views Data Views code and UI - index patterns before 8.0 Feature:Kibana Management Feature label for Data Views, Advanced Setting, Saved Object management pages Feature:Runtime Fields release_note:skip Skip the PR/issue when compiling release notes v7.13.0 v7.14.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@mattkime @elasticmachine @lcawl @kibanamachine @LeeDr