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

[data views] Swap references API docs #175183

Merged
merged 19 commits into from
Jan 29, 2024
Merged

Conversation

mattkime
Copy link
Contributor

@mattkime mattkime commented Jan 21, 2024

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.

Copy link
Contributor

Documentation preview:

@mattkime mattkime changed the title Swap references docs [data views] Swap references API docs Jan 23, 2024
@mattkime mattkime self-assigned this Jan 23, 2024
@mattkime mattkime added Feature:Data Views Data Views code and UI - index patterns before 8.0 Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. docs labels Jan 23, 2024
@mattkime mattkime marked this pull request as ready for review January 23, 2024 05:37
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

@mattkime mattkime added release_note:skip Skip the PR/issue when compiling release notes release_note:feature Makes this part of the condensed release notes v8.10.0 v8.11.0 v8.12.0 v8.13.0 and removed release_note:feature Makes this part of the condensed release notes labels Jan 23, 2024
Copy link
Contributor

@amyjtechwriter amyjtechwriter left a 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.

docs/api/data-views/swap_references.asciidoc Outdated Show resolved Hide resolved
docs/api/data-views/swap_references.asciidoc Outdated Show resolved Hide resolved
docs/api/data-views/swap_references_preview.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@amyjtechwriter amyjtechwriter left a comment

Choose a reason for hiding this comment

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

LGMT - thank you!

Copy link
Contributor

@davismcphee davismcphee left a 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 👍

docs/api/data-views/swap_references.asciidoc Outdated Show resolved Hide resolved
docs/api/data-views/swap_references_preview.asciidoc Outdated Show resolved Hide resolved
docs/api/data-views/swap_references_preview.asciidoc Outdated Show resolved Hide resolved
docs/api/data-views/swap_references.asciidoc Outdated Show resolved Hide resolved
docs/api/data-views/swap_references_preview.asciidoc Outdated Show resolved Hide resolved
docs/api/data-views/swap_references.asciidoc Outdated Show resolved Hide resolved
@mattkime mattkime merged commit b371171 into elastic:main Jan 29, 2024
6 checks passed
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 <[email protected]>
Co-authored-by: Davis McPhee <[email protected]>
(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 <[email protected]>
Co-authored-by: Davis McPhee <[email protected]>
(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 <[email protected]>
Co-authored-by: Davis McPhee <[email protected]>
(cherry picked from commit b371171)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.10
8.11
8.12

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":"[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]>
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":"[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]>
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":"[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]>
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 <[email protected]>
Co-authored-by: Davis McPhee <[email protected]>
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 <[email protected]>
Co-authored-by: Davis McPhee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Feature:Data Views Data Views code and UI - index patterns before 8.0 release_note:skip Skip the PR/issue when compiling release notes Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. v8.10.0 v8.10.5 v8.11.0 v8.11.5 v8.12.0 v8.12.1 v8.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants