[data views] Swap references API docs#175183
Merged
mattkime merged 19 commits intoelastic:mainfrom Jan 29, 2024
Merged
Conversation
Contributor
|
Documentation preview: |
Contributor
|
Pinging @elastic/kibana-data-discovery (Team:DataDiscovery) |
amyjtechwriter
suggested changes
Jan 23, 2024
Contributor
amyjtechwriter
left a comment
There was a problem hiding this comment.
This looks really nice, thank you for this! I've left a few suggestions to make the pages a bit more uniform with the others, but please check my prefixes.
Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
amyjtechwriter
approved these changes
Jan 23, 2024
Contributor
amyjtechwriter
left a comment
There was a problem hiding this comment.
LGMT - thank you!
davismcphee
approved these changes
Jan 24, 2024
Contributor
davismcphee
left a comment
There was a problem hiding this comment.
Thanks for adding docs! I left some minor bits of feedback, although most are take or leave minus a couple typos, so I'm approving now since it otherwise LGTM 👍
Co-authored-by: Davis McPhee <davismcphee@hotmail.com>
Co-authored-by: Davis McPhee <davismcphee@hotmail.com>
Co-authored-by: Davis McPhee <davismcphee@hotmail.com>
Co-authored-by: Davis McPhee <davismcphee@hotmail.com>
Co-authored-by: Davis McPhee <davismcphee@hotmail.com>
Co-authored-by: Davis McPhee <davismcphee@hotmail.com>
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jan 29, 2024
## Summary Docs for the swap references api - elastic#163225 The docs are on the terse side - I think this makes sense since this is a tool that should be used infrequently and only by people who use saved object references. --------- Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com> Co-authored-by: Davis McPhee <davismcphee@hotmail.com> (cherry picked from commit b371171)
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jan 29, 2024
## Summary Docs for the swap references api - elastic#163225 The docs are on the terse side - I think this makes sense since this is a tool that should be used infrequently and only by people who use saved object references. --------- Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com> Co-authored-by: Davis McPhee <davismcphee@hotmail.com> (cherry picked from commit b371171)
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jan 29, 2024
## Summary Docs for the swap references api - elastic#163225 The docs are on the terse side - I think this makes sense since this is a tool that should be used infrequently and only by people who use saved object references. --------- Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com> Co-authored-by: Davis McPhee <davismcphee@hotmail.com> (cherry picked from commit b371171)
Contributor
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Jan 29, 2024
# Backport This will backport the following commits from `main` to `8.10`: - [[data views] Swap references API docs (#175183)](#175183) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Matthew Kime","email":"matt@mattki.me"},"sourceCommit":{"committedDate":"2024-01-29T21:04:20Z","message":"[data views] Swap references API docs (#175183)\n\n## Summary\r\n\r\nDocs for the swap references api -\r\nhttps://github.com//pull/163225\r\n\r\nThe docs are on the terse side - I think this makes sense since this is\r\na tool that should be used infrequently and only by people who use saved\r\nobject references.\r\n\r\n---------\r\n\r\nCo-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>","sha":"b371171d86adc0bcd3a331be8526571370916330","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Data Views","release_note:skip","docs","Team:DataDiscovery","v8.10.0","v8.11.0","v8.12.0","v8.13.0"],"title":"[data views] Swap references API docs","number":175183,"url":"https://github.com/elastic/kibana/pull/175183","mergeCommit":{"message":"[data views] Swap references API docs (#175183)\n\n## Summary\r\n\r\nDocs for the swap references api -\r\nhttps://github.com//pull/163225\r\n\r\nThe docs are on the terse side - I think this makes sense since this is\r\na tool that should be used infrequently and only by people who use saved\r\nobject references.\r\n\r\n---------\r\n\r\nCo-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>","sha":"b371171d86adc0bcd3a331be8526571370916330"}},"sourceBranch":"main","suggestedTargetBranches":["8.10","8.11","8.12"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.11","label":"v8.11.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.12","label":"v8.12.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.13.0","branchLabelMappingKey":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/175183","number":175183,"mergeCommit":{"message":"[data views] Swap references API docs (#175183)\n\n## Summary\r\n\r\nDocs for the swap references api -\r\nhttps://github.com//pull/163225\r\n\r\nThe docs are on the terse side - I think this makes sense since this is\r\na tool that should be used infrequently and only by people who use saved\r\nobject references.\r\n\r\n---------\r\n\r\nCo-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>","sha":"b371171d86adc0bcd3a331be8526571370916330"}}]}] BACKPORT--> Co-authored-by: Matthew Kime <matt@mattki.me>
kibanamachine
added a commit
that referenced
this pull request
Jan 29, 2024
# Backport This will backport the following commits from `main` to `8.12`: - [[data views] Swap references API docs (#175183)](#175183) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Matthew Kime","email":"matt@mattki.me"},"sourceCommit":{"committedDate":"2024-01-29T21:04:20Z","message":"[data views] Swap references API docs (#175183)\n\n## Summary\r\n\r\nDocs for the swap references api -\r\nhttps://github.com//pull/163225\r\n\r\nThe docs are on the terse side - I think this makes sense since this is\r\na tool that should be used infrequently and only by people who use saved\r\nobject references.\r\n\r\n---------\r\n\r\nCo-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>","sha":"b371171d86adc0bcd3a331be8526571370916330","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Data Views","release_note:skip","docs","Team:DataDiscovery","v8.10.0","v8.11.0","v8.12.0","v8.13.0"],"title":"[data views] Swap references API docs","number":175183,"url":"https://github.com/elastic/kibana/pull/175183","mergeCommit":{"message":"[data views] Swap references API docs (#175183)\n\n## Summary\r\n\r\nDocs for the swap references api -\r\nhttps://github.com//pull/163225\r\n\r\nThe docs are on the terse side - I think this makes sense since this is\r\na tool that should be used infrequently and only by people who use saved\r\nobject references.\r\n\r\n---------\r\n\r\nCo-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>","sha":"b371171d86adc0bcd3a331be8526571370916330"}},"sourceBranch":"main","suggestedTargetBranches":["8.10","8.11","8.12"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.11","label":"v8.11.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.12","label":"v8.12.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.13.0","branchLabelMappingKey":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/175183","number":175183,"mergeCommit":{"message":"[data views] Swap references API docs (#175183)\n\n## Summary\r\n\r\nDocs for the swap references api -\r\nhttps://github.com//pull/163225\r\n\r\nThe docs are on the terse side - I think this makes sense since this is\r\na tool that should be used infrequently and only by people who use saved\r\nobject references.\r\n\r\n---------\r\n\r\nCo-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>","sha":"b371171d86adc0bcd3a331be8526571370916330"}}]}] BACKPORT--> Co-authored-by: Matthew Kime <matt@mattki.me>
kibanamachine
added a commit
that referenced
this pull request
Jan 29, 2024
# Backport This will backport the following commits from `main` to `8.11`: - [[data views] Swap references API docs (#175183)](#175183) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Matthew Kime","email":"matt@mattki.me"},"sourceCommit":{"committedDate":"2024-01-29T21:04:20Z","message":"[data views] Swap references API docs (#175183)\n\n## Summary\r\n\r\nDocs for the swap references api -\r\nhttps://github.com//pull/163225\r\n\r\nThe docs are on the terse side - I think this makes sense since this is\r\na tool that should be used infrequently and only by people who use saved\r\nobject references.\r\n\r\n---------\r\n\r\nCo-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>","sha":"b371171d86adc0bcd3a331be8526571370916330","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Data Views","release_note:skip","docs","Team:DataDiscovery","v8.10.0","v8.11.0","v8.12.0","v8.13.0"],"title":"[data views] Swap references API docs","number":175183,"url":"https://github.com/elastic/kibana/pull/175183","mergeCommit":{"message":"[data views] Swap references API docs (#175183)\n\n## Summary\r\n\r\nDocs for the swap references api -\r\nhttps://github.com//pull/163225\r\n\r\nThe docs are on the terse side - I think this makes sense since this is\r\na tool that should be used infrequently and only by people who use saved\r\nobject references.\r\n\r\n---------\r\n\r\nCo-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>","sha":"b371171d86adc0bcd3a331be8526571370916330"}},"sourceBranch":"main","suggestedTargetBranches":["8.10","8.11","8.12"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.11","label":"v8.11.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.12","label":"v8.12.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.13.0","branchLabelMappingKey":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/175183","number":175183,"mergeCommit":{"message":"[data views] Swap references API docs (#175183)\n\n## Summary\r\n\r\nDocs for the swap references api -\r\nhttps://github.com//pull/163225\r\n\r\nThe docs are on the terse side - I think this makes sense since this is\r\na tool that should be used infrequently and only by people who use saved\r\nobject references.\r\n\r\n---------\r\n\r\nCo-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>","sha":"b371171d86adc0bcd3a331be8526571370916330"}}]}] BACKPORT--> Co-authored-by: Matthew Kime <matt@mattki.me>
CoenWarmer
pushed a commit
to CoenWarmer/kibana
that referenced
this pull request
Feb 15, 2024
## Summary Docs for the swap references api - elastic#163225 The docs are on the terse side - I think this makes sense since this is a tool that should be used infrequently and only by people who use saved object references. --------- Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com> Co-authored-by: Davis McPhee <davismcphee@hotmail.com>
fkanout
pushed a commit
to fkanout/kibana
that referenced
this pull request
Mar 4, 2024
## Summary Docs for the swap references api - elastic#163225 The docs are on the terse side - I think this makes sense since this is a tool that should be used infrequently and only by people who use saved object references. --------- Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com> Co-authored-by: Davis McPhee <davismcphee@hotmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Summary
Docs for the swap references api - #163225
The docs are on the terse side - I think this makes sense since this is a tool that should be used infrequently and only by people who use saved object references.