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

[DOCS] Adds runtime fields #99395

Merged
merged 10 commits into from
May 12, 2021
Merged

Conversation

KOTungseth
Copy link
Contributor

@KOTungseth KOTungseth commented May 5, 2021

Summary

@elasticmachine
Copy link
Contributor

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

@elastic-jb
Copy link

We might want to add something to the bullet about selecting type that clarifies that your scripts output MUST match the output type or the script will not work. They should get an error, but it's probably worth making it clear that it will not convert any types.

Copy link
Contributor

@flash1293 flash1293 left a comment

Choose a reason for hiding this comment

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

Left some comments. Can be done later, but it would be cool to extend the tutorial to contain a real-world example of how runtime field can be used.

docs/user/dashboard/lens.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/lens.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/lens.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/lens.asciidoc Outdated Show resolved Hide resolved
@elastic-jb
Copy link

I'm not sure I would use the language "we add fields to documents." I get the intent of what it's trying to say, but runtime fields are added to index patterns and that could be misleading in how it's worded. The first two bullets in the value list might make more sense reversed also, the schema-less concept being first.

In the list of product tools that work, we should be re-enforcing that they work anywhere an index pattern is used. Instead of an app to app concept to think about, the model is they work everywhere except.... and list anything that doesn't support index patterns.

For the create runtime fields section, we should use Discover or Lens as an example. Not everyone has access to index pattern management. That will be less limiting for someone wanting to try them.

The Lens page looks ok to me.

@KOTungseth
Copy link
Contributor Author

KOTungseth commented May 11, 2021

I'm not sure I would use the language "we add fields to documents." I get the intent of what it's trying to say, but runtime fields are added to index patterns and that could be misleading in how it's worded. The first two bullets in the value list might make more sense reversed also, the schema-less concept being first.

I don't see "we add fields to documents" in this PR, but I reversed the bulleted list of benefits.

In the list of product tools that work, we should be re-enforcing that they work anywhere an index pattern is used. Instead of an app to app concept to think about, the model is they work everywhere except.... and list anything that doesn't support index patterns.

I've removed the list, but I'd still like to call out Discover and Lens in the bulleted list of benefits.

For the create runtime fields section, we should use Discover or Lens as an example. Not everyone has access to index pattern management. That will be less limiting for someone wanting to try them.

This section is geared towards admins, who should have access to index pattern management. For analysts that want to create runtime fields, they can refer to the Discover and Lens Add fields sections.

Kaarina Tungseth and others added 3 commits May 11, 2021 11:40
@elastic elastic deleted a comment from cla-checker-service bot May 11, 2021
@KOTungseth
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs

@cla-checker-service
Copy link

❌ Author of the following commits did not sign a Contributor Agreement:
537732a

Please, read and sign the above mentioned agreement if you want to contribute to this project

@KOTungseth KOTungseth merged commit 4a56a01 into elastic:master May 12, 2021
@KOTungseth KOTungseth deleted the docs/runtime-fields branch May 12, 2021 20:48
KOTungseth added a commit to KOTungseth/kibana that referenced this pull request May 12, 2021
* [DOCS] Runtime fields

* [DOCS] Runtime fields

* Adds examples and Lens changes

* Review comments

* Adds redirects

* Review comments

* Revert "Review comments"

This reverts commit 537732a.

* Review comments

* Fixes broken link

* Removes duplicate link

Co-authored-by: Kaarina Tungseth <[email protected]>
KOTungseth added a commit to KOTungseth/kibana that referenced this pull request May 12, 2021
* [DOCS] Runtime fields

* [DOCS] Runtime fields

* Adds examples and Lens changes

* Review comments

* Adds redirects

* Review comments

* Revert "Review comments"

This reverts commit 537732a.

* Review comments

* Fixes broken link

* Removes duplicate link

Co-authored-by: Kaarina Tungseth <[email protected]>
KOTungseth added a commit that referenced this pull request May 12, 2021
* [DOCS] Runtime fields

* [DOCS] Runtime fields

* Adds examples and Lens changes

* Review comments

* Adds redirects

* Review comments

* Revert "Review comments"

This reverts commit 537732a.

* Review comments

* Fixes broken link

* Removes duplicate link

Co-authored-by: Kaarina Tungseth <[email protected]>

Co-authored-by: Kaarina Tungseth <[email protected]>
KOTungseth added a commit that referenced this pull request May 12, 2021
* [DOCS] Runtime fields

* [DOCS] Runtime fields

* Adds examples and Lens changes

* Review comments

* Adds redirects

* Review comments

* Revert "Review comments"

This reverts commit 537732a.

* Review comments

* Fixes broken link

* Removes duplicate link

Co-authored-by: Kaarina Tungseth <[email protected]>

Co-authored-by: Kaarina Tungseth <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants