Data plugin README by lizozom · Pull Request #78750 · elastic/kibana

lizozom · 2020-09-29T10:51:48Z

Summary

Improve the data plugin README.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
This was checked for keyboard-only and screenreader accessibility
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2020-09-29T10:51:51Z

Pinging @elastic/kibana-app-arch (Team:AppArch)

lizozom · 2020-09-29T10:53:37Z

@gchaps I'd like to update the line describing the data plugin in here too.
Do you know where should this be changed? Any suggestions for a better phrasing?

Dosant · 2020-09-29T11:02:56Z

@gchaps I'd like to update the line describing the data plugin in here too.
Do you know where should this be changed? Any suggestions for a better phrasing?

@lizozom node scripts/build_plugin_list_docs

ppisljar · 2020-09-29T11:18:26Z

should we also convert to asciidocs ?

lizozom · 2020-09-29T12:26:01Z

@elasticmachine merge upstream

lizozom · 2020-09-29T13:55:06Z

@ppisljar @Dosant done!

…a into docs/search-service-readme

docs/developer/plugin-list.asciidoc

src/plugins/data/README.md

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

…ervice-readme

…a into docs/search-service-readme

gchaps

LGTM. Suggest using "high-level" and "low-level"

src/plugins/data/README.md

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

lukasolson

Love this, such a good start to improve docs on our services. Added a few notes below that we should probably add at some point, but don't necessarily need to be in this PR.

lukasolson · 2020-09-30T17:51:34Z

src/plugins/data/README.md

+
+    const searchSource = await data.search.searchSource.create();
+    const searchResponse = await searchSource
+      .setParent(undefined)


Nit: Add a short explanation of how search source inherits from the root search source (global time filter) by default and explain that this overrides that default behavior

lukasolson · 2020-09-30T17:52:19Z

src/plugins/data/README.md

+#### Default Search Strategy
+
+One benefit of using the low-level search API, is partial response support in X-Pack, allowing for a better and more responsive user experience.
+In OSS only the final result is returned. 


Nit: Add a note about how we also apply defaults from advanced settings/config.yml so that the consumer doesn't need to worry about these

kibanamachine · 2020-09-30T19:14:03Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 8481a61

Metrics [docs]

✅ unchanged

History

💚 Build #78227 succeeded 129e229
💚 Build #78048 succeeded 07d22df
💚 Build #78040 succeeded 6c23345
💚 Build #78036 succeeded 0d6eef0
💔 Build #78059 failed b5e17fe

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

* data readme * Delete old readme (other folders don't have a README of their own. * generate asciidoc * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update README.md * Update plugin-list.asciidoc * gen plugin list * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> # Conflicts: # src/plugins/data/README.md

* master: (36 commits) [I18n] fix eui tokens (elastic#78951) Changed the color of the confirm button in trusted app deletion dialog. (elastic#78768) Make the actual Vislib import async (elastic#78949) Fix ML conditionals links Cypress tests (elastic#78568) [Drilldowns][Docs] Communicate the visualization types that support drilldowns (elastic#78761) [UX] Improve page-load axis (elastic#78392) [SECURITY SOLUTIONS] Map embeddable working with index patterns selection (elastic#78610) Data plugin README (elastic#78750) [TSVB] Request validation error: [panels.0.series.0.metrics.0.percentiles.1.value] (elastic#79009) fixing api test (elastic#78964) [Task names in TaskManager] Rename "telemetry" to "usage" (elastic#78129) [Loggers] Rename "telemetry" to "usage" (elastic#78130) [Usage Collection] [schema] `ui_metric` (elastic#78827) [Actions][Jira] Set parent issue for Sub-task issue type (elastic#78772) [Discover] Unskip doc link functional test (elastic#78600) [ML] Functional tests - stabilize calendar edit tests (elastic#78950) [UX] Improve page responsive (elastic#78759) [QA][Code Coverage] Team Assignment Docs Update (elastic#78890) [ML] Migrate machine learning URLs to BrowserRouter format for APM, Security, and Infra (elastic#78209) [ts] enable "resolveJsonModule" and disable existing failures (elastic#78855) ...

* data readme * Delete old readme (other folders don't have a README of their own. * generate asciidoc * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update README.md * Update plugin-list.asciidoc * gen plugin list * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Update src/plugins/data/README.md Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> # Conflicts: # src/plugins/data/README.md

Liza K added 2 commits September 29, 2020 13:48

data readme

e526139

Delete old readme (other folders don't have a README of their own.

7e76977

lizozom added v8.0.0 Team:AppArch release_note:skip Skip the PR/issue when compiling release notes v7.10.0 labels Sep 29, 2020

lizozom requested review from alexh97, gchaps and lukasolson September 29, 2020 10:51

lizozom requested a review from a team as a code owner September 29, 2020 10:51

lizozom self-assigned this Sep 29, 2020

elasticmachine and others added 2 commits September 29, 2020 08:26

Merge branch 'master' into docs/search-service-readme

018964b

generate asciidoc

e3a9b47

Merge branch 'docs/search-service-readme' of github.com:lizozom/kiban…

cdfc28f

…a into docs/search-service-readme

gchaps reviewed Sep 29, 2020

View reviewed changes

lizozom and others added 9 commits September 29, 2020 21:43

Update src/plugins/data/README.md

0d6eef0

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

0e5e299

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

79e64b7

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

6c23345

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

f872f4e

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

9c67a21

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

f5bbdb6

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

ab3a3a1

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

51dbf51

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

lizozom and others added 8 commits September 29, 2020 21:49

Update src/plugins/data/README.md

abcf85d

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

8cd1954

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

07d22df

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update README.md

e69566c

Update plugin-list.asciidoc

b5e17fe

Merge branch 'master' of github.com:elastic/kibana into docs/search-s…

e79e987

…ervice-readme

Merge branch 'docs/search-service-readme' of github.com:lizozom/kiban…

729faa2

…a into docs/search-service-readme

gen plugin list

129e229

gchaps approved these changes Sep 30, 2020

View reviewed changes

src/plugins/data/README.md Outdated Show resolved Hide resolved

src/plugins/data/README.md Outdated Show resolved Hide resolved

src/plugins/data/README.md Outdated Show resolved Hide resolved

lizozom and others added 3 commits September 30, 2020 20:39

Update src/plugins/data/README.md

51d4c58

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

fd2f505

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Update src/plugins/data/README.md

8481a61

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

lukasolson approved these changes Sep 30, 2020

View reviewed changes

lizozom merged commit 09226db into elastic:master Oct 1, 2020

lizozom mentioned this pull request Oct 1, 2020

[7.x] Data plugin README (#78750) #79084

Merged

Conversation

lizozom commented Sep 29, 2020

Summary

Checklist

For maintainers

Uh oh!

elasticmachine commented Sep 29, 2020

Uh oh!

lizozom commented Sep 29, 2020

Uh oh!

Dosant commented Sep 29, 2020

Uh oh!

ppisljar commented Sep 29, 2020

Uh oh!

lizozom commented Sep 29, 2020

Uh oh!

lizozom commented Sep 29, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gchaps left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lukasolson left a comment

Choose a reason for hiding this comment

Uh oh!

lukasolson Sep 30, 2020

Choose a reason for hiding this comment

Uh oh!

lukasolson Sep 30, 2020

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Sep 30, 2020

💚 Build Succeeded

Metrics [docs]

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants