Developer guide - index patterns key concepts #96017
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattkime
changed the title
mattkime
added
v7.15.0
v8.0.0
Feature:Data Views
|
Pinging @elastic/kibana-app-services (Team:AppServices) |
mattkime
added
release_note:skip
|
@elasticmachine merge upstream |
Dosant
reviewed
Aug 12, 2021
dev_docs/tutorials/data_views.mdx
Outdated
| - Remove a scripted field — `DELETE /api/index_patterns/index_pattern/{id}/scripted_field/{name}` | ||
| - Update a scripted field — `POST /api/index_patterns/index_pattern/{id}/scripted_field/{name}` | ||
|
|
||
| ### Dat aview API |
There was a problem hiding this comment.
Suggested change
| ### Dat aview API | |
| ### Data view API |
| await data.indexPatterns.delete(dataViewId); | ||
| ``` | ||
|
|
||
| ### Data view HTTP API |
There was a problem hiding this comment.
Maybe we should delete this completely? (also delete from plugin readme)
- We have a more complete version at https://www.elastic.co/guide/en/kibana/master/index-patterns-api.html
- I don't think this belongs to
tutorials - I hope we will come to automatically generated rest API docs in the future, so don't think it is worth think much were to put it for now
Dosant
approved these changes
Aug 12, 2021
There was a problem hiding this comment.
LGTM tested locally,
As mentioned before suggest removing REST API mentions. Or maybe link from here to user-facing docs https://www.elastic.co/guide/en/kibana/master/index-patterns-api.html
dev_docs/key_concepts/data_views.mdx
Outdated
|
|
||
|
|
||
| The data view API is made available via the data plugin (`data.indexPatterns`, soon to be renamed) and most commonly used with <DocLink id="kibDevTutorialDataSearchAndSessions" section="high-level-search" text="SearchSource" /> | ||
| (`data.search.search`) to perform queries. SearchSource will apply existing filters and queries from the search bar UI. |
There was a problem hiding this comment.
Suggested change
| (`data.search.search`) to perform queries. SearchSource will apply existing filters and queries from the search bar UI. | |
| (`data.search.search.searchSource`) to perform queries. SearchSource will apply existing filters and queries from the search bar UI. |
…kibana into key_concept_index_pattern_docs
💚 Build SucceededMetrics [docs]
History
To update your PR or re-run it, just comment with: |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Aug 15, 2021
* add index patterns key concepts
💚 Backport successful
This backport PR will be merged automatically after passing CI. |
kibanamachine
added a commit
that referenced
this pull request
Aug 15, 2021
* add index patterns key concepts Co-authored-by: Matthew Kime <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes: #92125
Adds index patterns key concept content to the developer guide.
Also moved a bunch of index pattern content from the data plugin readme to a tutorial page. The tutorial page is a straight ahead iteration over simple API use cases. It could use another pass but I didn't want the added scope creep to this task.
This PR adds the sidebar nav items - https://github.com/elastic/elastic-docs-next/pull/266