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.

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

Add help text for runtime fields source. #85204

Merged

Conversation

lockewritesdocs
Copy link
Contributor

Summary

Adds (or tries to) help text to the source field for runtime fields, introduced in #84184.

image

Accessing the changes

  1. Navigate to Index Management.
  2. Choose Index Templates and define an index template.
  3. Under Mapping, choose Runtime fields.

The text should display under the script field (it doesn't).

Checklist

Delete any items that are not applicable to this PR.

@alisonelizabeth alisonelizabeth added the Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more label Dec 8, 2020
@elasticmachine
Copy link
Contributor

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

@alisonelizabeth
Copy link
Contributor

@lockewritesdocs I updated your PR so that the help text displays now. Let me know if you think it is OK as-is, or if you prefer to have the text and link separate in a two-column layout (the text is a little long so it felt weird when I initially had it that way).

Screen Shot 2020-12-07 at 9 39 55 PM

@lockewritesdocs
Copy link
Contributor Author

Thanks for the assist @alisonelizabeth! I made some minor text changes and also defined an EuiCode element for _source. Built and tested locally without errors, so 🤞

Copy link
Contributor

@alisonelizabeth alisonelizabeth left a comment

Choose a reason for hiding this comment

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

Change LGTM. Tested locally. Thanks for working on this @lockewritesdocs!

@alisonelizabeth alisonelizabeth added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes and removed release_note:enhancement labels Dec 8, 2020
@alisonelizabeth
Copy link
Contributor

Note: I added the 8.0.0 tag and changed release_note:enhancement to release_note:skip, since this is just a docs change and I believe there is already a release note for the overall runtime fields feature.

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Distributable file count

id before after diff
default 46933 47693 +760

Page load bundle

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

id before after diff
runtimeFields 30.9KB 31.3KB +446.0B

History

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

@lockewritesdocs lockewritesdocs merged commit 72ed936 into elastic:master Dec 8, 2020
@lockewritesdocs lockewritesdocs deleted the runtime-fields-helptext branch December 8, 2020 19:51
lockewritesdocs pushed a commit that referenced this pull request Dec 8, 2020
* Add help text for runtime fields source.

* fix help text

* Text changes and defining EuiCode element for _source.

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

Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Index Management Index and index templates UI Feature:Mappings Editor Index mappings editor UI release_note:skip Skip the PR/issue when compiling release notes Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v7.11.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants