Skip to content

Conversation

@florent-leborgne
Copy link
Contributor

@florent-leborgne florent-leborgne commented Nov 25, 2025

Summary

This PR updates the page opening of all Dashboards docs pages. In particular:

  • Check that the frontmatter is correct and contains the right metadata
  • More generally, frontmatter is often missing an intentional description in many docs files
  • Optimized H1
  • Optimized page intro based on basic content types (tutorial/explanation/guide/reference) that provides better context and sets better expectations

These changes follow instructions provided to AI following an onweek project: https://github.com/florent-leborgne/mi-instructions

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

Tool(s) and model(s) used: Cursor with Claude Sonnet 4.5

@florent-leborgne florent-leborgne requested review from a team as code owners November 25, 2025 17:39
@github-actions
Copy link

github-actions bot commented Nov 25, 2025

Vale Linting Results

Summary: 5 suggestions found

💡 Suggestions (5)
File Line Rule Message
explore-analyze/dashboards.md 25 Elastic.WordChoice Consider using 'efficient' instead of 'simple', unless the term is in the UI.
explore-analyze/dashboards/create-dashboard-of-panels-with-ecommerce-data.md 16 Elastic.FutureTense 'you'll have' might be in future tense. Write in the present tense to describe the state of the product as it is now.
explore-analyze/dashboards/create-dashboard-of-panels-with-web-server-data.md 16 Elastic.FutureTense 'you'll have' might be in future tense. Write in the present tense to describe the state of the product as it is now.
explore-analyze/dashboards/import-dashboards.md 14 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
explore-analyze/dashboards/using.md 16 Elastic.FutureTense 'You'll also' might be in future tense. Write in the present tense to describe the state of the product as it is now.

Copy link
Contributor

@benironside benironside left a comment

Choose a reason for hiding this comment

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

Overall I like this. Most of my suggestions were very minor. After a while I stopped commenting about possibly using attributes in the page description frontmatter, in case it's not applicable. Was this all done by AI or did you participate too?

Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
@florent-leborgne
Copy link
Contributor Author

Thanks @benironside - to answer your questions:

  • yes all of this is AI-generated as I'm working on refining a set of instructions, which explains some of the styling here - we're missing this kind of things in about every single page we have, so we must find a way to implement it in a way that requires minimum creation and review efforts yet still leading to significant improvements and good (enough) quality.
  • we can't use variables in the frontmatter right now

@florent-leborgne florent-leborgne requested review from a team and benironside November 26, 2025 15:04
@bmorelli25 bmorelli25 requested a review from alaudazzi December 2, 2025 17:50
Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

I left a few suggestions that AI might reconsider :)

@florent-leborgne
Copy link
Contributor Author

Noticed a few things were wrong with the privilege terminology - I fixed them here and will fix them in the instructions too.
I think it's merge-able but lmk if you think otherwise

@florent-leborgne florent-leborgne requested a review from a team December 5, 2025 14:51
@bmorelli25
Copy link
Member

@alaudazzi can you pls take another look at this

Copy link
Contributor

@alaudazzi alaudazzi 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 few more comments.

@alaudazzi
Copy link
Contributor

@florent-leborgne I started reviewing, and I can continue tomorrow.
It looks good. A couple more points for your consideration:

1/
Some screenshots could be removed (Use filter pills) and
some screenshots could be retaken (Apply a global time range to an entire dashboard)

2/
It's weird to have the headings in reverse order between landing page and nav:
image

@alaudazzi
Copy link
Contributor

@florent-leborgne I scanned through the remaining pages, they look good to me. I haven't tested every single step of the many procedures documented in these pages. Tutorials are OK because they were recently refreshed against the current UI.

Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

LGTM

@florent-leborgne florent-leborgne enabled auto-merge (squash) December 11, 2025 17:45
@florent-leborgne florent-leborgne merged commit cf465b2 into elastic:main Dec 11, 2025
7 of 8 checks passed
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.

4 participants