Feature #5261

[Workbench] Show project description in its own tab

Added by Tom Clegg almost 6 years ago. Updated over 5 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Workbench
Target version:
Start date:
03/04/2015
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
0.5

Description

The description tab should become the leftmost tab.

This tab should be the initially displayed tab -- unless the description is empty, in which case the collections tab should be initially displayed (but the description tab should still be the leftmost tab).


Subtasks

Task #5385: Update testsResolvedTom Clegg

Task #5347: Rearrange projects#show layoutResolvedTom Clegg

Task #5389: Review 5261-project-descriptionResolvedTom Clegg

Associated revisions

Revision 633660dc
Added by Tom Clegg over 5 years ago

Merge branch '5261-project-description' closes #5261

History

#1 Updated by Tom Clegg almost 6 years ago

  • Tracker changed from Bug to Feature
  • Description updated (diff)
  • Category set to Workbench
  • Assigned To set to Tom Clegg

#2 Updated by Tom Clegg over 5 years ago

  • Status changed from New to In Progress

#3 Updated by Radhika Chippada over 5 years ago

  • The new Summary tab displays Name and Description (partial: 'name_and_description’). This needs to be split into two separate partials (I explain below)
  • The “Name” of the project is only shown in the Summary tab.
    • When I traverse to any other tab, the Name field goes away. Yes, it is visible in the topnav, but this is different than any other object displays in our system (for example, pipeline instance).
    • To change the name, one needs to go back to Summary tab as opposed to have it accessible right at the top of the page, though this is not a big deal.
    • However, the major issue is, when the shared project is being visited by an anonymous user, the Name is not visible when the user is in any other tab other than Summary tab. Since we do not display the project Name in the topnav also in this context, the user does not know the project name at all in this context. I think it is not good user experience. I think the Name should be where it used to be and should always be visible in all contexts. This is also similar to all other object displays for the anonymous experience.
  • We should rename Summary tab as Description tab. Once we move Name out of the Summary tab, this is basically just the description anyways. It will be just one attribute name between object model and display and less confusing from code maintenance and usability perspective. I also like the name Description better than Summary, especially when it is just description being displayed.
  • Editing description - It would be nice if we can improve this UI (if it is not too much to ask)
    • The pencil to edit description is at the bottom of the display area. Earlier it was ok, but with long description occupying the entire page / tab, the pencil icon at the bottom does not look user friendly. It was especially jarring when I had description long enough to fill the page. I had to scroll down to see it and access it. When I had it almost full, I had to scroll down after clicking it. I think it would be nice if we have the pencil icon at the top of the description or as a top left (with a little border) or something like that.
    • Also the display (when not editing) is within the box surrounded by the pencil icon, rather than appearing like it is occupying the entire page (when the horizontal width of the longest line occupies only half or so of the page).
    • The editable text box is still using a very small area. It would be nice if it occupies a bigger area.
    • I think it can be an Edit button at the top instead of pencil that opens up a dialog where the user can enter the description.
  • All workbench tests passed for me
  • Did not find anything (else) weird in manual testing.

#4 Updated by Tom Clegg over 5 years ago

Radhika Chippada wrote:

  • The “Name” of the project is only shown in the Summary tab.

Fixed. → 9b3c1e9

  • We should rename Summary tab as Description tab. Once we move Name out of the Summary tab, this is basically just the description anyways. It will be just one attribute name between object model and display and less confusing from code maintenance and usability perspective. I also like the name Description better than Summary, especially when it is just description being displayed.

I think the most important question is what makes the most sense to users (even if it's inconvenient for developers). But it's easy to rename back and forth, so sure, let's start with Description. → 8c19d0d

(Nancy suggested "Readme" which I think is another contender...)

  • Editing description - It would be nice if we can improve this UI (if it is not too much to ask)

While everyone seems to agree the editing UI should improve, this story is primarily meant to benefit the reader/visitor (more than the author/owner) and we decided it shouldn't get delayed by bundling it with additional improvements meant for the author's benefit.

#5 Updated by Radhika Chippada over 5 years ago

  • Agree with you about "editing description". Let's not worry about it at this time.
  • I do not like "Read me" for the tab title. Sounds too "non-UI-ish" . Anyways, you changed it to "Description" for now :).
  • Project name display when name is nil is wrong. It is displaying "New group" instead of "New project". (Interestingly, it displays "New project" for anonymous view and "New group" for logged in user). Please update it to say "New project" anyways in projects/show.html.erb
  • Everything else LGTM

#6 Updated by Anonymous over 5 years ago

  • Status changed from In Progress to Resolved
  • % Done changed from 67 to 100

Applied in changeset arvados|commit:633660dcd81d4ddea5c0a55a7731af35c4586052.

Also available in: Atom PDF