Repository navigation
[TEST] gh-aw v1.0.1 rollout: retry settings page - #9250
theletterf wants to merge 1 commit into
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Docs review summary
Action required
- Add a
descriptionto the frontmatter. The page has onlynavigation_title(frontmatter). The page also has noproductsorapplies_to, so the versions and deployments wheremax_retriesandbackoff_msapply aren't stated. - The technical claims were not checked against product source or published docs. The defaults, the
retry_exhaustedevent and the legacy mode have no SME evidence in the PR.
Review coverage
- Content type: how-to with a short troubleshooting section. The page is a basic fit for the pattern.
- Checked: user focus, technical accuracy (limited), applicability, maintainability, language, and style.
- Not checked: the skill rule sets under
.claude/skills/were not read in this run, so the review applied the rubric directly. Technical accuracy was not checked against source or published docs.
Generated from Docs review agent
Was this review helpful? When the PR closes, add the label
ai-review:helpfulorai-review:unhelpfulto it.
| navigation_title: Retry settings | ||
| --- | ||
|
|
||
| # Retry Settings For The Ingest Pipeline |
There was a problem hiding this comment.
Headings use sentence case (formatting). Change # Retry Settings For The Ingest Pipeline to:
| # Retry Settings For The Ingest Pipeline | |
| # Retry settings for the ingest pipeline |
|
|
||
| # Retry Settings For The Ingest Pipeline | ||
|
|
||
| Retries are configured by the user in the pipeline settings. When a bulk request fails, the request will be retried up to the configured maximum, and a backoff delay is applied by the pipeline between each attempt. |
There was a problem hiding this comment.
"the request will be retried" uses future tense. Use present tense (verb tense) and active voice (voice-tone):
| Retries are configured by the user in the pipeline settings. When a bulk request fails, the request will be retried up to the configured maximum, and a backoff delay is applied by the pipeline between each attempt. | |
| You configure retries in the pipeline settings. When a bulk request fails, the pipeline retries it up to the configured maximum and applies a backoff delay between attempts. |
|
|
||
| ## Configure retries | ||
|
|
||
| To configure retries you should go into the settings file and set the following options, which is a really simple process: |
There was a problem hiding this comment.
"you should go into the settings file" is wordy and addresses the reader indirectly (minimal wording). Line 7 says retries are set in the "pipeline settings", while this line says "settings file" and step 1 gives a URL, so the location of the settings is unclear. Use one term throughout:
| To configure retries you should go into the settings file and set the following options, which is a really simple process: | |
| To configure retries, set the following options in the pipeline settings: |
| 2. Set `max_retries` to the number of attempts you want. | ||
| 3. Set `backoff_ms` to the delay between attempts. | ||
|
|
||
| Note: the default for `max_retries` is 5. Values above 10 are leveraged only in the legacy mode. |
There was a problem hiding this comment.
Two issues on the quoted line "Values above 10 are leveraged only in the legacy mode": "leveraged" is jargon, so use "used" (word choice). "legacy mode" is also undefined, and the default and limit are unscoped by version, so link to or define that mode. Replace the plain Note: prefix with a MyST {note} admonition, or move the default into the step 2 text.
|
|
||
| ## Troubleshooting | ||
|
|
||
| If requests still fail after the max retries has been reached, the failures are logged by the pipeline and the batch is dropped. Check the logs for the `retry_exhausted` event. |
There was a problem hiding this comment.
Subject-verb disagreement in "the max retries has been reached" (grammar-spelling):
| If requests still fail after the max retries has been reached, the failures are logged by the pipeline and the batch is dropped. Check the logs for the `retry_exhausted` event. | |
| If requests still fail after the maximum number of retries is reached, the pipeline logs the failures and drops the batch. Check the logs for the `retry_exhausted` event. |
|
Test PR for the gh-aw v1.0.1 rollout (elastic/docs-actions#447, merged). Closing. |
Test PR for the gh-aw v1.0.1 rollout (elastic/docs-actions#447). Not for review and not for merge. It will be closed and its branch deleted shortly.