[UX] Consolidated plan items list page
Summary
The goal of this work is to define our transition away from having separate list pages for work items (Epics vs Issues) and into a single list experience. This makes it easier for users to manage their work, instead of needing to manage multiple lists that aren't connected. This also paves the way for future improvements that we have planned for the list page such as a nested hierarchy.
Proposal
Consolidate the existing Issues list (/issues) and Epics list (/epics) to a shared Work items list (/work_items). At the project level, where Epics do not yet exist, the Issues list will also be renamed to Work items.
In addition, we will be introducing some other changes to solve current UX concerns and set us up for some of the future work around Saved Views. This includes eliminating the current State (open/closed/all) Tabs in favor of a filter, as well as relocating the result count to be below the filter criteria.
With consolidating Epic and Issue items, we will also need to take into account how that can effect things like bulk editing from the list page, as certain fields/attributes are not shared across these types.
Acceptance criteria
Navigation changes (Approved by Foundations ✅ )
-
At the group level, the EpicsandIssuesnavigation items will be consolidated toWork items -
At the project level, the Issuesnavigation item will be renamed toWork items -
We will not include the count of total work items next to the navigation item at this time. This may change later based on feedback. -
For users who have Pinned the legacy navigation items (either IssuesorEpics), we will automatically Pin the newWork itemsnavigation item for them.
Path changes
-
With the above navigation changes, the path for the new Work items list will be /work_items -
Epic detail pages will no longer follow the /epics/IIDpattern, but instead use/work_items/IID -
Issue (and Incident) detail pages will no longer follow the /issues/IIDpattern, but instead use/work_items/IID- Other WITs (such as Tasks and OKRs) already use the
/work_items/path
- Other WITs (such as Tasks and OKRs) already use the
-
With these path changes, we need to ensure there are redirects in place for the old paths (#513115 (closed) - list pages, #579837 (closed) - detail pages)
Breadcrumbs changes
-
On the new Work items list page, the breadcrumb should now use Work itemsinstead ofIssuesorEpics. -
On Epic detail pages, the breadcrumb should now use Work itemsinstead ofEpics -
On Issue detail pages (and Incidents), the breadcrumb should now use Work itemsinstead ofIssues(#579638 (closed)) -
On OKRs and Task detail pages, the breadcrumb should also use Work itemsinstead ofIssues
Global "Create new" flow (top of left nav)
Menu
-
[Group level] Rename New epictoNew work item -
[Project level] Rename New issuetoNew work itemNote: These menu options will continue to live under
In this groupandIn this projectheadings until we fully support global creation (being able to select any namespace).
Create form
-
Add the Group/Project(namespace) selector as the first field- Defaulted to current namespace
- Available options would be limited to namespaces within the root group
-
Add the Typeselector- Options available would be based on namespace selected (#517558 (closed))
- Default selection to the last used (if available). Otherwise default to Epic type when a group namespace is selected, and Issue type when a project namespace selected. (#517559)
New item button (top of list)
-
Rename the existing New issue/New Epicbutton toNew item, which opens the create form modal -
If current namespace is a Group: Group/Project(namespace) selector should be the first field in the modal- Defaulted to the current namespace
- Available options would be limited to namespaces within the root group
-
If current namespace is a Project: Do not show the Group/Project(namespace) selector.- New item must be added to the current project, thus this is the default namespace (though it isn't shown in the form as it isn't needed)
-
Typeselector should be the second field in the modal- Options available would be based on namespace selected (#517558 (closed))
- Default selection to the last used (if available). Otherwise default to Epic type when a group namespace is selected, and Issue type when a project namespace selected. (#517559)
Changes to State filtering
-
The current Tabs for State(open/closed/all) should be removed in favor of a new filter option in the filter bar. -
The new filter within the filter bar should be named State, using theissue-open-micon within the dropdown. -
Options for the Statefilter should includeOpen,Closed, andAny(Anybeing separated in the options at the top similar to other filters such as Label) -
The List page by default should include the Statefilter, set toOpen(matching our current experience where we default to the Open tab)
Type filtering
-
Users will be able to filter by various types using the Typefilter (which has already been present on Issues list)- Allows users to create the same types of views they previously were able to with the Issues/Epics lists, while now allowing Epics to be combined with the other types.
- Allow multiple Type selections using the OR operator (#548480 (closed))
Sticky header
-
The row containing the filter bar and display options should be sticky during vertical scrolling, as seen in this prototype. (#579975 (closed)) - Only apply the sticky header on
mediumviewport and larger.
- Only apply the sticky header on
Results count
-
We will show the results count below the filter bar (above result items) - This count will be based only on the results of the filters/query, meaning you will no longer see counts for all
Stateslike seen today in the Tabs.
- This count will be based only on the results of the filters/query, meaning you will no longer see counts for all
Results
-
At the group level, results will now combine Epics and Issues (as well as other types already combined today on Issues). -
There is no additional weighting or sorting for the different work item types, and would follow the sort criteria defined in the sort setting.
Sorting
-
The sort options available should be a combination of what is seen in the Epics list and Issues list today - Essentially, it would be the Issues list options with the addition of
Start dateandDue datewhich is only on Epics today.
- Essentially, it would be the Issues list options with the addition of
-
If a sort option doesn't apply to a work item type, those items would be at the end of the list and sorted by a default method (it looks like today this is by IID in descending order)
Filtering
-
When filtering by criteria that doesn’t apply to a certain type (ex: Iteration with Epics in listing), those types should not appear after filtering since they don’t meet/have the criteria (#580269 - followup for later, not GA)
Bulk Editing
-
When selecting items to bulk edit, only display bulk edit options in the sidebar that are common for all of the selected items - (ex: "Color" would not be available when an Epic and an Issue are both selected – since it is only an Epic attribute).
List actions
-------------------------------
Related changes – can be broken out
Group-level settings (Settings > Issues) - #580271
-
Update the nav item from IssuestoWork items -
Update the page title from IssuestoWork items
Project-level settings (Settings > General > Visibility) - #580271
-
Rename IssuestoWork items -
Update the description text based on proposed improvements - Current: Flexible tool to collaboratively develop ideas and plan work in this project. Learn more.
- New: Plan and track work with flexible objects and views. Learn more.
-
Update where the Learn morelink directs: https://docs.gitlab.com/user/work_items/
"Assigned issues" changes (nav shortcut and page in "Your work") - #580272
-
Rename the nav shortcut be "Assigned work items" (tooltip and aria label) -
Update the nav shortcut to use the work itemsicon -
Rename the Issuespage in "Your work" toWork items(nav item and page heading)
Milestone report (#537770 (closed))
-
Update the list headers (underneath Tabs) to use the work-itemsicon rather than theissuesicon. -
Update the links that navigate to the list page to use the work items list -
In the right sidebar the links for "Open" & "Closed" (under Work items) should navigate to the work item list (and use associated filters). -
When items within "Work items" Tab is greater than 500, the alert we show which includes a "View all" link should go to the work item list.
-
-------------------------------
Documentation updates
There are various places where we reference the path (ex: Plan > Issues or Plan > Epics) that will need updated, as well as this will be a good time to consider changes to the overall structure of these sections, and consolidating some of that information into a Work items section (discussed in &16344 (closed)).
- Issues
- Epics
- Tasks
- Issue boards
- Epic boards
- All issues assigned to you (related to "Assigned issues" section above)
- Milestone report page
- Project settings