Overhaul of Trento Web documentation - #263
Conversation
abravosuse
left a comment
There was a problem hiding this comment.
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
left a comment
There was a problem hiding this comment.
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.
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. |
88c1c5f to
bf3df59
Compare
| // 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. |
There was a problem hiding this comment.
note: it seems to be distinguished by type instead of tooltip, check if that is going to change
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:
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