-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[data views] Swap references API docs #175183
Conversation
Documentation preview: |
Pinging @elastic/kibana-data-discovery (Team:DataDiscovery) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 <[email protected]>
Co-authored-by: amyjtechwriter <[email protected]>
Co-authored-by: amyjtechwriter <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGMT - thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 <[email protected]>
Co-authored-by: Davis McPhee <[email protected]>
Co-authored-by: Davis McPhee <[email protected]>
Co-authored-by: Davis McPhee <[email protected]>
Co-authored-by: Davis McPhee <[email protected]>
Co-authored-by: Davis McPhee <[email protected]>
## 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 <[email protected]> Co-authored-by: Davis McPhee <[email protected]> (cherry picked from commit b371171)
## 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 <[email protected]> Co-authored-by: Davis McPhee <[email protected]> (cherry picked from commit b371171)
## 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 <[email protected]> Co-authored-by: Davis McPhee <[email protected]> (cherry picked from commit b371171)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
# 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":"[email protected]"},"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 <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","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 <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","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 <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"b371171d86adc0bcd3a331be8526571370916330"}}]}] BACKPORT--> Co-authored-by: Matthew Kime <[email protected]>
# 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":"[email protected]"},"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 <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","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 <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","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 <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"b371171d86adc0bcd3a331be8526571370916330"}}]}] BACKPORT--> Co-authored-by: Matthew Kime <[email protected]>
# 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":"[email protected]"},"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 <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","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 <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","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 <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"b371171d86adc0bcd3a331be8526571370916330"}}]}] BACKPORT--> Co-authored-by: Matthew Kime <[email protected]>
## 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 <[email protected]> Co-authored-by: Davis McPhee <[email protected]>
## 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 <[email protected]> Co-authored-by: Davis McPhee <[email protected]>
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.