Reindex conflicts clarification (docs) #40442
Conversation
Made it more clear that conflicts : proceed only affects version conflicts.
henningandersen
added
>docs
|
Pinging @elastic/es-distributed |
docs/reference/docs/reindex.asciidoc
Outdated
| By default, version conflicts abort the `_reindex` process, but you can just | ||
| count them by setting `"conflicts": "proceed"` in the request body: | ||
| By default, version conflicts abort the `_reindex` process. The `"conflicts"` request body | ||
| parameter can be used to instruct `_reindex` to proceed with next document on version conflicts. |
There was a problem hiding this comment.
Suggestion:
parameter can be used to instruct _reindex to proceed with the next document on version conflicts.
There was a problem hiding this comment.
Fixed in 7f76ba8
docs/reference/docs/reindex.asciidoc
Outdated
| count them by setting `"conflicts": "proceed"` in the request body: | ||
| By default, version conflicts abort the `_reindex` process. The `"conflicts"` request body | ||
| parameter can be used to instruct `_reindex` to proceed with next document on version conflicts. | ||
| Notice that the handling of other types of errors is unaffected by the `"conflicts"` parameter. |
There was a problem hiding this comment.
Suggestion:
The handling of other types of errors is unaffected by the "conflicts" parameter.
I think that the Notice that part is unnecessary and feels weird for this documentation. If you do want emphasis, I would probably go with "It is important to note that the handling of other error types is unaffected by the..."
There was a problem hiding this comment.
I opted for keeping the emphasis with your modified text. The whole point of this PR was this note, since that was the clarification asked for in the issue. See 7f76ba8
docs/reference/docs/reindex.asciidoc
Outdated
| By default, version conflicts abort the `_reindex` process. The `"conflicts"` request body | ||
| parameter can be used to instruct `_reindex` to proceed with next document on version conflicts. | ||
| Notice that the handling of other types of errors is unaffected by the `"conflicts"` parameter. | ||
| By setting `"conflicts": "proceed"` in the request body the `_reindex` process will continue on version conflicts |
There was a problem hiding this comment.
This is confusing because "By setting...the _reindex process will continue" seems to suggest that it is the process that is setting the parameter.
Suggestion:
When "conflicts": "proceed" is set in the request body, the _reindex process will continue on version conflicts
There was a problem hiding this comment.
Thanks, so good to have native speakers review docs, fixed in 7f76ba8
Better English...
|
Thanks @tbrooks8 , this should be ready for another look. |
Made it more clear that conflicts : proceed only affects version conflicts.
Made it more clear that conflicts : proceed only affects version conflicts.
|
Backported to 7.x, 7.0 and 6.7. |
* elastic/7.0: [TEST] Mute WebhookHttpsIntegrationTests.testHttps [DOCS] Add 'time value' links to several monitor settings (elastic#40633) (elastic#40687) Do not perform cleanup if Manifest write fails with dirty exception (elastic#40519) Remove mention of soft deletes from getting started (elastic#40668) Fix bug in detecting use of bundled JDK on macOS Reindex conflicts clarification (docs) (elastic#40442) SQL: [Tests] Enable integration tests for fixed issues (elastic#40664) Add information about the default sort mode (elastic#40657) SQL: [Docs] Fix example for CURDATE SQL: [Docs] Fix doc errors regarding CURRENT_DATE. (elastic#40649) Clarify using time_zone and date math in range query (elastic#40655) Add notice for bundled jdk (elastic#40576) disable kerberos test until kerberos fixture is working again [DOCS] Use "source" instead of "inline" in ML docs (elastic#40635) Unmute and fix testSubParserArray (elastic#40626) Geo Point parse error fix (elastic#40447) Increase suite timeout to 30 minutes for docs tests (elastic#40521) Fix repository-hdfs when no docker and unnecesary fixture Avoid building hdfs-fixure use an image that works instead
Made it more clear that conflicts : proceed only affects version conflicts.
Made it more clear that conflicts : proceed only affects version
conflicts.
Relates to #17617