Update documentation for namespace overview #21
Conversation
|
@cshinn I just added a summary issue https://github.com/kiali/kiali-design/issues/22 at the same time! |
There was a problem hiding this comment.
2 questions/comments in addition to inline comments:
- in both popover and in click the cursor in the mockup is hand palm. In case of popover - should it also be a handpalm to indicate it's clickable? (just making sure for implementation purposes)
- the tooltip for 15 greens services says "service in error, service 2 in error" , for clarity it would be nicer to have non error service names for the "green" services example :)
namespace-overview/design.md
Outdated
| ### Namespace Cards | ||
| - **Title:** Displays the name of the namespace. May wrap to a second line if necessary. | ||
| - **Status Counts:** Shows the number of services with each status. Icons should only be shown for a given status if there are services in the namespace that have that status. | ||
| - **Service Count:** The total number of services in the namespace. |
There was a problem hiding this comment.
count should come before status counts
namespace-overview/design.md
Outdated
| ### Card interactions | ||
| - Clicking on a card links to a view of the services list filtered by the relevant namespace | ||
| - Clicking on a status count links to a view of the services with that status in the selected namespace | ||
| - Hovering over a status count displays a popover with a list of the services with that status. |
There was a problem hiding this comment.
with a list of service names (not all service information)
namespace-overview/design.md
Outdated
| - Clicking on a card links to a view of the services list filtered by the relevant namespace | ||
| - Clicking on a status count links to a view of the services with that status in the selected namespace | ||
| - Hovering over a status count displays a popover with a list of the services with that status. | ||
| - If more than 6 services with a given status exist, the popover should show the names of the first 5 followed by the message "and # more..." to describe the total number |
| ### Namespace Cards | ||
| - **Title:** Displays the name of the namespace. May wrap to a second line if necessary. | ||
| - **Service Count:** The total number of services in the namespace. | ||
| - **Status Counts:** Shows the number of services with each status. Icons should only be shown for a given status if there are services in the namespace that have that status. |
There was a problem hiding this comment.
Except green, right? Or if all are green then indicate X services green
|
|
||
|
|
||
| ### Card interactions | ||
| - Clicking on a card links to a view of the services list filtered by the relevant namespace |
There was a problem hiding this comment.
@cshinn this is a bit confusing to me. The view is called namespaces, the name on the card is namespace, so I think clicking on the card would imply that the user would navigate to the namespace.
Could we instead provide a link on the #Services and allow that to provide the navigation?
There was a problem hiding this comment.
Please define "navigate to the namespace" - for me this would be the graph of that namespace (in what mode?)
There was a problem hiding this comment.
Is there a plan to include namespaces as objects in Kiali? AFAIK right now they're really only represented as attributes on services
There was a problem hiding this comment.
@cshinn no, namespaces are not "direct" objects in Kiali. Those are k8s/openshift objects that are used for filtering in Kiali. I don't expect this to change.
There was a problem hiding this comment.
My point is just that if the view is called namespaces, and we are navigating to services, it should be done so by clicking the "services" link, rather than the card.
namespace-overview/design.md
Outdated
| ### Card interactions | ||
| - Clicking on a card links to a view of the services list filtered by the relevant namespace | ||
| - Clicking on a status count links to a view of the services with that status in the selected namespace | ||
| - Hovering over a status count displays a popover with a list of the names of services with that status. |
There was a problem hiding this comment.
If it's a hover, should it be a tooltip rather than an Infotip? I don't remember if there is relevant PF guidance.
There was a problem hiding this comment.
yeah, tooltip would be a better word to use here. I'll update
| @@ -1,21 +1,18 @@ | |||
| # Namespace Overview | |||
There was a problem hiding this comment.
The view shows Filter and Sort components.
What are available sorting fields ? Name and Status?
Are we allowing them to filter by anything else?
There was a problem hiding this comment.
We could sort by number of services as well. Might be useful
|
Can we make that that cards that show warnings / errors automatically bubble up to the top (on refresh)? Those with errors should go before the ones that have warnings only. |
|
@pilhuhn that's the plan for the sorting. Who will create that formula? |
|
@serenamarie125 Great. |
|
@abonas now that the graph has switched to showing applications instead of services, are there changes that need to be made to this design? Should we show applications/workloads instead, or should both services and workloads be included? |
|
@mwringe @lucasponce can you please address @cshinn question above? |
|
I should say that the graph represents applications, workloads and also services. |
Updates designs and documentation for the namespace overview based on feedback and requirements
Closes #22