Skip to content

Overhaul of Trento Web documentation - #263

Open
eromanova97 wants to merge 3 commits into
mainfrom
TRNT-4501
Open

Overhaul of Trento Web documentation#263
eromanova97 wants to merge 3 commits into
mainfrom
TRNT-4501

Conversation

@eromanova97

@eromanova97 eromanova97 commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Description

Overhaul of Trento Web documentation:

Problem statement

The current chapter is a UI tour: it enumerates sidebar entries, then walks the reader through each list view and each details view section by section ("click X to open Y, which shows A, B, C"). Three consequences:

  • Low user value. The console is self-explanatory at that level. A reader who is already looking at the Hosts view learns nothing from a paragraph that says the Hosts view lists hosts.
  • Passive framing. The text describes what the UI contains, never what the user should conclude or do. There is no answer to "the icon is yellow,now what?"
  • The genuinely Trento-specific logic is missing. Aggregated health -> the one thing a reader cannot derive by looking at the screen, gets very small coverage.

Rewrite thesis: the chapter's job is to explain the health model (how Trento turns dozens of raw signals into one icon), the staleness model (when that icon is no longer trustworthy), and the path from icon to root cause.

Fixes https://jira.suse.com/browse/TRNT-4501, https://jira.suse.com/browse/TRNT-4512, https://jira.suse.com/browse/TRNT-4468, https://jira.suse.com/browse/TRNT-4467

Preview

Trento web documentation - SLES-SAP-trento_en.pdf
-> Chapter 11: Monitoring SAP health in the Trento Web console

Question that needs an answer

  • Would those passive descriptions possibly be beneficial for AI crawlers? I wonder if, for example, the Liz assistant relies on the docs for such information. I want to make sure cutting that fluff does not remove context that LLMs might rely on for step-by-step guides.

@eromanova97
eromanova97 marked this pull request as draft August 7, 2026 12:08

@abravosuse abravosuse left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Amazing work @eromanova97 ! I think the new approach that you propose is much more useful for the customer. And I love the new troubleshooting section. Just a few suggestions from my side to consider.

Comment thread trento/adoc/trento-web-console.adoc Outdated
Comment thread trento/adoc/trento-web-console.adoc Outdated
Comment thread trento/adoc/trento-web-console.adoc Outdated
Comment thread trento/adoc/trento-web-console.adoc Outdated
Comment thread trento/adoc/trento-web-console.adoc Outdated
Comment thread trento/adoc/trento-web-console.adoc Outdated
Comment thread trento/adoc/trento-web-console.adoc Outdated
Comment thread trento/adoc/trento-web-console.adoc Outdated
Comment thread trento/adoc/trento-web-console.adoc Outdated
Comment thread trento/adoc/trento-web-console.adoc Outdated

@abravosuse abravosuse left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Amazing work @eromanova97 ! I think the new approach that you propose is much more useful for the customer. And I love the new troubleshooting section. Just a few suggestions from my side to consider.

@abravosuse

Copy link
Copy Markdown
Collaborator

Question that needs an answer
Would those passive descriptions possibly be beneficial for AI crawlers? I wonder if, for example, the Liz assistant relies on > the docs for such information. I want to make sure cutting that fluff does not remove context that LLMs might rely on for step-by-step guides.

BTW @eromanova97 I just realized that I did not address this question in my review. In my opinion, we should focus on making the documentation as useful as possible for anybody reading it and your changes are going in that direction. Let's not concern ourselves right now with AI crawlers and such. In the end, we have it in our roadmap to bring UI context to the embedded assistant Liz. When we address this topic, we can study ways to make Liz understand better what the different elements in the UI mean and the proper way to understand/use them.

@eromanova97
eromanova97 force-pushed the TRNT-4501 branch 2 times, most recently from 88c1c5f to bf3df59 Compare August 20, 2026 07:33
@eromanova97 eromanova97 changed the title [draft] Overhaul of Trento Web documentation Overhaul of Trento Web documentation Aug 20, 2026
Comment on lines +394 to +395
// TODO: The draft said a tooltip distinguishes the two. Verify against the running product, then either
// mention the tooltip or tell the reader how else to tell them apart.

@eromanova97 eromanova97 Aug 20, 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.

note: it seems to be distinguished by type instead of tooltip, check if that is going to change

@eromanova97
eromanova97 marked this pull request as ready for review August 20, 2026 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants