Doc updates for AutoOps React migration#6673
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. |
Vale Linting ResultsSummary: 4 warnings, 2 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/monitor/autoops/ec-autoops-deployment-view.md | 44 | Elastic.DontUse | Don't use 'just'. |
| deploy-manage/monitor/autoops/ec-autoops-event-settings.md | 30 | Elastic.BritishSpellings | Use American English spelling 'dialog' instead of British English 'dialogue'. |
| deploy-manage/monitor/autoops/ec-autoops-events.md | 36 | Elastic.DontUse | Don't use 'just'. |
| deploy-manage/monitor/autoops/ec-autoops-nodes-view.md | 19 | Elastic.DirectionalLanguage | Don't use directional language. Use 'the label of the element' instead of 'on the right side'. |
💡 Suggestions (2)
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/monitor/autoops/ec-autoops-events.md | 35 | Elastic.Wordiness | Consider using 'whether' instead of 'whether or not'. |
| deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md | 35 | Elastic.Repetition | "the" is repeated. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
|
React migration rollout has been pushed to a later date. This PR is on hold. |
|
React migration is now unblocked. I've refreshed all the screenshots and text in 0c86829 to reflect the most recent changes. |
georgewallace
left a comment
There was a problem hiding this comment.
Minor changes needed.
| The **Event Settings** report provides a list of all the events for which the settings were modified. | ||
|
|
||
| From the **Event Settings** report, you can click **Add** to add new settings, or select the edit icon to modify the existing settings. | ||
| The **Event settings** report provides a list of all the events for which settings have been customized. |
There was a problem hiding this comment.
Not sure if this is right or wrong. But the page is called Events settings, I see event and events being used as references to the UI. Should it be Events settings and not Event settings?
There was a problem hiding this comment.
there are more references in this page but just calling it out.
There was a problem hiding this comment.
You're right. This instance should be "Events settings". The UI uses "events settings" for the report and "event settings" for the actual settings, so it's confusing.
I've done another sweep to update the other instances on the page too
| ### Metric selector | ||
| Use the metric selector to drill down into shard information based on different metrics. Select from the following: | ||
|
|
||
| * Indexing Latency |
There was a problem hiding this comment.
| * Indexing Latency | |
| * Indexing latency |
There was a problem hiding this comment.
not part of your PR but there is title casing for these metrics and per the Ui they show sentence case.. Only tagged one here but there are others.
There was a problem hiding this comment.
I'm still seeing title case in the UI. Maybe we're looking at different things? This section is specifically talking about the selector on the right side of the Shards page
Summary
Updates text and screenshots to reflect the new React changes in AutoOps + updates text to reflect new Critical severity type. I also did some general clean up.
Main changes
SEVERITYfield from 3 to 4Closes https://github.com/elastic/opex-product/issues/770, https://github.com/elastic/opex-product/issues/790
Generative AI disclosure