Skip to content

[UA] Update UI copy for batch reindex API#209403

Merged
TinaHeiligers merged 7 commits intoelastic:mainfrom
TinaHeiligers:kbn209081/UA_batch_reindex_UI_copy_update
Feb 4, 2025
Merged

[UA] Update UI copy for batch reindex API#209403
TinaHeiligers merged 7 commits intoelastic:mainfrom
TinaHeiligers:kbn209081/UA_batch_reindex_UI_copy_update

Conversation

@TinaHeiligers
Copy link
Contributor

@TinaHeiligers TinaHeiligers commented Feb 3, 2025

fix #209081

Updates UI copy for the batch reindexing API only supporting indices.

Note to reviewers: There wasn't an entry for the translation id for French.

@TinaHeiligers TinaHeiligers added release_note:skip Skip the PR/issue when compiling release notes Feature:Upgrade Assistant v9.0.0 docs backport:version Backport to applied version labels v8.18.0 v8.19.0 labels Feb 3, 2025
@TinaHeiligers TinaHeiligers requested a review from a team as a code owner February 3, 2025 19:07
@TinaHeiligers TinaHeiligers requested review from a team and removed request for a team February 3, 2025 19:08
Copy link
Contributor

@jloleysens jloleysens left a comment

Choose a reason for hiding this comment

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

Left a q about also updating the ascii docs! Let me know what you think. I also asked for review from docs team, let's hear what they have to say!

<FormattedMessage
id="xpack.upgradeAssistant.esDeprecations.batchReindexingDocsDescription"
defaultMessage="To start multiple reindexing tasks in a single request, use the Kibana {docsLink}."
defaultMessage="To start upgrading multiple reindexing tasks in a single request, use the Kibana {docsLink} for indices. The {docsLink} does not support data streams."
Copy link
Contributor

Choose a reason for hiding this comment

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

I was thinking, perhaps we should also add some clarification to the docs themselves too?

https://www.elastic.co/guide/en/kibana/current/batch-start-resume-reindex.html

docs/api/upgrade-assistant/batch_reindexing.asciidoc. WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The asciidoc updates need to be made directly to the pre-9 branches. I'll link back to the original issue for tracking.

Copy link
Contributor

Choose a reason for hiding this comment

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

It's ok to do them here if this whole PR is going to be backported along with it, for simplicity.

But in any case the docs change will have to be done again for 9.0+ in the new docs system.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

WDYT about using something similar to the kib UI copy:
"Start or resume upgrading multiple indices in one request. Additionally, reindexing tasks for upgrading indices that are started or resumed via the batch endpoint will be placed on a queue and executed one-by-one. This ensures that minimal cluster resources are consumed over time. Note: this API does not support data streams."

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good to me 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@florent-leborgne the docs update is failing.

Copy link
Contributor

Choose a reason for hiding this comment

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

The "Comment on PR for .asciidoc changes" check doesn't prevent from merging.
Only the "buildkite/docs-build-pr" is needed to merge docs changes

apply suggestion from PR review

Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
@TinaHeiligers
Copy link
Contributor Author

@elasticmachine merge upstream

Copy link
Contributor

@jloleysens jloleysens 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 addressing the feedback. Approving bc the changes are in the UI, approving to unblock progress.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2025

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

@TinaHeiligers
Copy link
Contributor Author

For posterity, updated docs:

Screenshot 2025-02-04 at 10 25 34

@TinaHeiligers TinaHeiligers enabled auto-merge (squash) February 4, 2025 17:34
@elasticmachine
Copy link
Contributor

elasticmachine commented Feb 4, 2025

💔 Build Failed

Failed CI Steps

History

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2025

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

@TinaHeiligers TinaHeiligers merged commit bdc3470 into elastic:main Feb 4, 2025
8 of 9 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.18, 8.x, 9.0

https://github.com/elastic/kibana/actions/runs/13142316498

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Feb 4, 2025
fix elastic#209081

Updates UI copy for the batch reindexing API only supporting indices.

Note to reviewers: There wasn't an entry for the translation id for
French.

---------

Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
(cherry picked from commit bdc3470)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Feb 4, 2025
fix elastic#209081

Updates UI copy for the batch reindexing API only supporting indices.

Note to reviewers: There wasn't an entry for the translation id for
French.

---------

Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
(cherry picked from commit bdc3470)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Feb 4, 2025
fix elastic#209081

Updates UI copy for the batch reindexing API only supporting indices.

Note to reviewers: There wasn't an entry for the translation id for
French.

---------

Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
(cherry picked from commit bdc3470)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.18
8.x
9.0

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 Feb 4, 2025
# Backport

This will backport the following commits from `main` to `8.18`:
- [[UA] Update UI copy for batch reindex API
(#209403)](#209403)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Christiane (Tina)
Heiligers","email":"christiane.heiligers@elastic.co"},"sourceCommit":{"committedDate":"2025-02-04T18:27:55Z","message":"[UA]
Update UI copy for batch reindex API (#209403)\n\nfix
https://github.com/elastic/kibana/issues/209081\r\n\r\nUpdates UI copy
for the batch reindexing API only supporting indices.\r\n\r\nNote to
reviewers: There wasn't an entry for the translation id
for\r\nFrench.\r\n\r\n---------\r\n\r\nCo-authored-by: Jean-Louis
Leysens <jloleysens@gmail.com>\r\nCo-authored-by: Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"bdc3470658b53c8d0a20461ed13b5e68015924c5","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:Upgrade
Assistant","v9.0.0","docs","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[UA]
Update UI copy for batch reindex
API","number":209403,"url":"https://github.com/elastic/kibana/pull/209403","mergeCommit":{"message":"[UA]
Update UI copy for batch reindex API (#209403)\n\nfix
https://github.com/elastic/kibana/issues/209081\r\n\r\nUpdates UI copy
for the batch reindexing API only supporting indices.\r\n\r\nNote to
reviewers: There wasn't an entry for the translation id
for\r\nFrench.\r\n\r\n---------\r\n\r\nCo-authored-by: Jean-Louis
Leysens <jloleysens@gmail.com>\r\nCo-authored-by: Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"bdc3470658b53c8d0a20461ed13b5e68015924c5"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/209403","number":209403,"mergeCommit":{"message":"[UA]
Update UI copy for batch reindex API (#209403)\n\nfix
https://github.com/elastic/kibana/issues/209081\r\n\r\nUpdates UI copy
for the batch reindexing API only supporting indices.\r\n\r\nNote to
reviewers: There wasn't an entry for the translation id
for\r\nFrench.\r\n\r\n---------\r\n\r\nCo-authored-by: Jean-Louis
Leysens <jloleysens@gmail.com>\r\nCo-authored-by: Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"bdc3470658b53c8d0a20461ed13b5e68015924c5"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co>
kibanamachine added a commit that referenced this pull request Feb 4, 2025
# Backport

This will backport the following commits from `main` to `8.x`:
- [[UA] Update UI copy for batch reindex API
(#209403)](#209403)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Christiane (Tina)
Heiligers","email":"christiane.heiligers@elastic.co"},"sourceCommit":{"committedDate":"2025-02-04T18:27:55Z","message":"[UA]
Update UI copy for batch reindex API (#209403)\n\nfix
https://github.com/elastic/kibana/issues/209081\r\n\r\nUpdates UI copy
for the batch reindexing API only supporting indices.\r\n\r\nNote to
reviewers: There wasn't an entry for the translation id
for\r\nFrench.\r\n\r\n---------\r\n\r\nCo-authored-by: Jean-Louis
Leysens <jloleysens@gmail.com>\r\nCo-authored-by: Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"bdc3470658b53c8d0a20461ed13b5e68015924c5","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:Upgrade
Assistant","v9.0.0","docs","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[UA]
Update UI copy for batch reindex
API","number":209403,"url":"https://github.com/elastic/kibana/pull/209403","mergeCommit":{"message":"[UA]
Update UI copy for batch reindex API (#209403)\n\nfix
https://github.com/elastic/kibana/issues/209081\r\n\r\nUpdates UI copy
for the batch reindexing API only supporting indices.\r\n\r\nNote to
reviewers: There wasn't an entry for the translation id
for\r\nFrench.\r\n\r\n---------\r\n\r\nCo-authored-by: Jean-Louis
Leysens <jloleysens@gmail.com>\r\nCo-authored-by: Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"bdc3470658b53c8d0a20461ed13b5e68015924c5"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/209403","number":209403,"mergeCommit":{"message":"[UA]
Update UI copy for batch reindex API (#209403)\n\nfix
https://github.com/elastic/kibana/issues/209081\r\n\r\nUpdates UI copy
for the batch reindexing API only supporting indices.\r\n\r\nNote to
reviewers: There wasn't an entry for the translation id
for\r\nFrench.\r\n\r\n---------\r\n\r\nCo-authored-by: Jean-Louis
Leysens <jloleysens@gmail.com>\r\nCo-authored-by: Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"bdc3470658b53c8d0a20461ed13b5e68015924c5"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co>
kibanamachine added a commit that referenced this pull request Feb 4, 2025
# Backport

This will backport the following commits from `main` to `9.0`:
- [[UA] Update UI copy for batch reindex API
(#209403)](#209403)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Christiane (Tina)
Heiligers","email":"christiane.heiligers@elastic.co"},"sourceCommit":{"committedDate":"2025-02-04T18:27:55Z","message":"[UA]
Update UI copy for batch reindex API (#209403)\n\nfix
https://github.com/elastic/kibana/issues/209081\r\n\r\nUpdates UI copy
for the batch reindexing API only supporting indices.\r\n\r\nNote to
reviewers: There wasn't an entry for the translation id
for\r\nFrench.\r\n\r\n---------\r\n\r\nCo-authored-by: Jean-Louis
Leysens <jloleysens@gmail.com>\r\nCo-authored-by: Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"bdc3470658b53c8d0a20461ed13b5e68015924c5","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:Upgrade
Assistant","v9.0.0","docs","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[UA]
Update UI copy for batch reindex
API","number":209403,"url":"https://github.com/elastic/kibana/pull/209403","mergeCommit":{"message":"[UA]
Update UI copy for batch reindex API (#209403)\n\nfix
https://github.com/elastic/kibana/issues/209081\r\n\r\nUpdates UI copy
for the batch reindexing API only supporting indices.\r\n\r\nNote to
reviewers: There wasn't an entry for the translation id
for\r\nFrench.\r\n\r\n---------\r\n\r\nCo-authored-by: Jean-Louis
Leysens <jloleysens@gmail.com>\r\nCo-authored-by: Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"bdc3470658b53c8d0a20461ed13b5e68015924c5"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/209403","number":209403,"mergeCommit":{"message":"[UA]
Update UI copy for batch reindex API (#209403)\n\nfix
https://github.com/elastic/kibana/issues/209081\r\n\r\nUpdates UI copy
for the batch reindexing API only supporting indices.\r\n\r\nNote to
reviewers: There wasn't an entry for the translation id
for\r\nFrench.\r\n\r\n---------\r\n\r\nCo-authored-by: Jean-Louis
Leysens <jloleysens@gmail.com>\r\nCo-authored-by: Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"bdc3470658b53c8d0a20461ed13b5e68015924c5"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co>
drewdaemon pushed a commit to drewdaemon/kibana that referenced this pull request Feb 6, 2025
fix elastic#209081

Updates UI copy for the batch reindexing API only supporting indices.

Note to reviewers: There wasn't an entry for the translation id for
French.

---------

Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
florent-leborgne added a commit to florent-leborgne/kibana that referenced this pull request Mar 31, 2025
florent-leborgne added a commit that referenced this pull request Apr 1, 2025
This change reproduces the asciidoc change made in
#209403 into the new API docs.
It'll be picked up the next time the API docs output is generated and
refreshed.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Apr 1, 2025
This change reproduces the asciidoc change made in
elastic#209403 into the new API docs.
It'll be picked up the next time the API docs output is generated and
refreshed.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit b7d1141)
kibanamachine added a commit that referenced this pull request Apr 4, 2025
# Backport

This will backport the following commits from `main` to `9.0`:
- [[Docs] Reproduce #209403 in new API docs
(#216439)](#216439)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT
[{"author":{"name":"florent-leborgne","email":"florent.leborgne@elastic.co"},"sourceCommit":{"committedDate":"2025-04-01T16:21:43Z","message":"[Docs]
Reproduce #209403 in new API docs (#216439)\n\nThis change reproduces
the asciidoc change made
in\nhttps://github.com//pull/209403 into the new API
docs.\nIt'll be picked up the next time the API docs output is generated
and\nrefreshed.\n\n---------\n\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"b7d1141b6b4e565647c30eac79773d5cf973724e","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","APIDocs","backport:version","v9.1.0"],"title":"[Docs]
Reproduce #209403 in new API
docs","number":216439,"url":"https://github.com/elastic/kibana/pull/216439","mergeCommit":{"message":"[Docs]
Reproduce #209403 in new API docs (#216439)\n\nThis change reproduces
the asciidoc change made
in\nhttps://github.com//pull/209403 into the new API
docs.\nIt'll be picked up the next time the API docs output is generated
and\nrefreshed.\n\n---------\n\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"b7d1141b6b4e565647c30eac79773d5cf973724e"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/216439","number":216439,"mergeCommit":{"message":"[Docs]
Reproduce #209403 in new API docs (#216439)\n\nThis change reproduces
the asciidoc change made
in\nhttps://github.com//pull/209403 into the new API
docs.\nIt'll be picked up the next time the API docs output is generated
and\nrefreshed.\n\n---------\n\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"b7d1141b6b4e565647c30eac79773d5cf973724e"}}]}]
BACKPORT-->

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:version Backport to applied version labels docs Feature:Upgrade Assistant release_note:skip Skip the PR/issue when compiling release notes v8.18.0 v8.19.0 v9.0.0 v9.1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[UA] Guidance to only use the batch reindex API on indices

5 participants