Skip to content

Doc updates for AutoOps React migration#6673

Open
wajihaparvez wants to merge 16 commits into
elastic:mainfrom
wajihaparvez:autoops-react-updates
Open

Doc updates for AutoOps React migration#6673
wajihaparvez wants to merge 16 commits into
elastic:mainfrom
wajihaparvez:autoops-react-updates

Conversation

@wajihaparvez

@wajihaparvez wajihaparvez commented May 22, 2026

Copy link
Copy Markdown
Contributor

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

Changes Docs preview link
Overview: Updated page description; added note about region availability; reordered sections; refreshed Top Events description; updated screenshots Overview
Deployment/Cluster view: Renamed "panels" to "sections" throughout; refreshed descriptions of Events over time, Open events, Event history, Resources, and Performance sections; added date/time picker guidance; updated screenshots Deployment view
Events: Updated severity levels to add Critical, reordered the flyout table (severity and notification status now listed first); updated action names (Customize → Settings, Notifications → Edit notification settings, Share event link → Share event); updated screenshot, wording cleanup Events
Event settings: Fixed title capitalization; updated instructions for accessing settings through the flyout actions menu; reordered settings list items; added screenshot of the Add event settings flyout Event settings
Notifications settings: Updated connector setup steps (Add → Add connector, Validate → Run to test, Filter Setting → Filter setting); simplified per-connector instructions to use cross-references; updated notification status description, updated webhook SEVERITY field from 3 to 4 Notifications settings
Nodes view: Added instructions for using the deployment/cluster dropdown and node selector; removed separate Nodes table and Open Events sections (now covered in Deployment view); renamed "panels" to "sections"; updated screenshot Nodes view
Indices view: Added guidance for the deployment/cluster dropdown and date/time picker; reordered navigation instructions; updated screenshot Indices view
Shards view: Added new sections documenting UI controls (time slider, nodes/indices selectors, metric selector, shard matrix); added screenshot of the shard cell popover Shards view
Template Optimizer: Expanded with new Recommendations and JSON Template sections; updated description of how templates are sorted; added new screenshot Template Optimizer

Closes https://github.com/elastic/opex-product/issues/770, https://github.com/elastic/opex-product/issues/790

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes: cursor in auto mode; claude
  • No

@wajihaparvez wajihaparvez self-assigned this May 22, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented May 22, 2026

Copy link
Copy Markdown
Contributor

Vale Linting Results

Summary: 4 warnings, 2 suggestions found

⚠️ Warnings (4)
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.

@wajihaparvez

Copy link
Copy Markdown
Contributor Author

React migration rollout has been pushed to a later date. This PR is on hold.

@wajihaparvez wajihaparvez marked this pull request as ready for review July 13, 2026 14:38
@wajihaparvez wajihaparvez requested a review from a team as a code owner July 13, 2026 14:38
@wajihaparvez wajihaparvez marked this pull request as draft July 13, 2026 14:38
@wajihaparvez wajihaparvez removed the request for review from arnonst July 13, 2026 14:38
@wajihaparvez wajihaparvez marked this pull request as ready for review July 14, 2026 01:22
@wajihaparvez

Copy link
Copy Markdown
Contributor Author

React migration is now unblocked. I've refreshed all the screenshots and text in 0c86829 to reflect the most recent changes.

@wajihaparvez wajihaparvez requested a review from ori-shafir July 14, 2026 01:23
@wajihaparvez wajihaparvez changed the title [DRAFT] Doc updates for AutoOps React migration Doc updates for AutoOps React migration Jul 14, 2026

@georgewallace georgewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Minor changes needed.

Comment thread deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

there are more references in this page but just calling it out.

@wajihaparvez wajihaparvez Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Indexing Latency
* Indexing latency

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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

Comment thread deploy-manage/monitor/autoops/ec-autoops-template-optimizer.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants