Skip to content

Commit 83c46e5

Browse files
committed
Spec for concept-b changes
1 parent 965e909 commit 83c46e5

1 file changed

Lines changed: 75 additions & 0 deletions

File tree

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
= Improvements/Enhancements required in concept-b implementation of Tendrl UI
2+
3+
== Introduction
4+
The intent of this change is to optimize the user experience and usability for the Tendrl users, i.e. allowing quicker access to managed objects through fewer steps, as well as allowing for dynamic product features (menu items) to be exposed based on a given context (cluster type). Moreover, it allows for easier access to top-level objects (cluster resources) being managed with a given cluster.
5+
6+
== Problem Description
7+
The Tendrl release 1.5.4 uses a navigation that requires multiple-level drill-down to examine details of objets with a cluster. Its navigation uses a static menu bar on the left with access to top-level objects only via drill-downs in the right pane, which is less than optimal.
8+
9+
* It’s not easy access to access cluster-top level objects without a drill-down, and it’s not obvious to user where they go to find volume information a quick glance.
10+
* To switch to another cluster from a drill-down, a user has to go to the Cluster via the menu item or breadcrumb to choose a different cluster (2 step/clicks).
11+
12+
To optimize and improve the user experience and usability, we want to introduce a more optimal navigation, whereby we use a Context Selector in the masthead to allow for quickly switching between clusters. Additionally, the left-hand navigation menu bar would be context-sensitive, i.e. the menu is shown in context of a selector cluster, allowing for different menu items (product features) to be presented for different cluster types (e.g. Ceph and Gluster). No navigation bar is shown when all clusters are selected. This is further detailed in [Concept B: Single Cluster / Element Manager Concept with Context Switcher Navigation (Optimized UX)](https://redhat.invisionapp.com/share/8QCOEVEY9).
13+
14+
== Proposed change
15+
16+
Following are the changes to be done in the concept-b implementaion -
17+
18+
* Remove expanded view for hosts from [cluster list view](https://redhat.invisionapp.com/share/8QCOEVEY9#/screens/244738628).
19+
* Modal for showing [import task errors](https://redhat.invisionapp.com/share/8QCOEVEY9#/screens/244738627).
20+
* Add a link to the 'All Clusters' view to open the import task details in a new page (at this point the left navigation will be hidden). Once a cluster is successfully imported, a link will be provided to direct the user to 'Cluster detail' views for the newly imported cluster.
21+
* In all list views, use buttons to show primary actions and kebab menu to show secondary actions.
22+
* Add 'Volumes count' and 'Alerts count' on cluster list view.
23+
* Add 'Bricks count' on host list view.
24+
* Integrate cluster specific Events and Tasks APIs.
25+
26+
=== Impacted Modules:
27+
28+
==== Tendrl API impact:
29+
30+
Required from API -
31+
32+
* Volumes and Alerts count in '/api/1.0/clusters' API.
33+
* Bricks count in '/api/1.0/clusters/{cluster_id}/nodes' API.
34+
* A way to get the import task id for unmanaged cluster in '/api/1.0/clusters' API to fetch task details for it. Unmanged clusters should have a property 'task_id' which will correspond to import task in clusters API.
35+
* API for fetching events and tasks per cluster level.
36+
37+
=== Performance Impact:
38+
There should be no UI performance impact due to this change.
39+
40+
== Implementation:
41+
42+
=== Assignee(s):
43+
44+
Primary assignee:
45+
gnehapk
46+
47+
Other contributors:
48+
None
49+
50+
=== Work Items:
51+
52+
https://github.com/Tendrl/ui/issues/780
53+
54+
== Dependencies:
55+
56+
https://github.com/Tendrl/api/issues/341 (Resolved)
57+
58+
https://github.com/Tendrl/api/issues/342 (Resolved)
59+
60+
https://github.com/Tendrl/api/issues/329 (Resolved)
61+
62+
https://github.com/Tendrl/api/issues/343 (Resolved)
63+
64+
== Acceptance Criteria:
65+
66+
The following should be satisfied to confirm that this spec is completed and working as intended:
67+
68+
* The left-navigation bar should only appear when a single cluster is selected in the Context Selector or from any place where a single cluster is selected, e.g. breadcrumb, hyperlink, etc.
69+
* When "All Clusters" is selected, there should be no left-navigation bar.
70+
71+
== References:
72+
73+
* https://redhat.invisionapp.com/share/8QCOEVEY9
74+
* https://redhat.invisionapp.com/share/8QCOEVEY9#/screens/244738628
75+
* https://redhat.invisionapp.com/share/8QCOEVEY9#/screens/244738627

0 commit comments

Comments
 (0)