Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Archived item navigation improvements #2062

Merged
merged 13 commits into from
Sep 10, 2024

Conversation

SuaYoo
Copy link
Collaborator

@SuaYoo SuaYoo commented Aug 30, 2024

Resolves #2056

Changes

  • Replaces QA Review breadcrumbs with "Back" button that takes you back to the archived item
  • Crawl breadcrumbs always point to workflow
  • Shows archived item icon next to item name to differentiate from workflow
  • Adds "Edit Workflow" button to "Crawl Settings"

Screenshots

Page Image/video
Crawl detail Screenshot 2024-09-03 at 3 40 33 PM
Crawl detail - Crawl Settings Screenshot 2024-09-03 at 3 54 28 PM
Upload detail Screenshot 2024-09-03 at 3 41 41 PM
Crawl detail - From collection Screenshot 2024-09-03 at 3 41 08 PM

@Shrinks99
Copy link
Member

Shrinks99 commented Sep 1, 2024

The back to crawl button on the QA page is a great addition. Similar to how I don't think we should use the menu actions for navigation when possible, I think we should move this to the overview section along with the workflow name and a link listed the same way we list collections in the metadata section. This isn't a completely holistic take — we use the settings gear buttons in the actions section of our panels and that functions as a link — but this feels more like navigating to a different section than configuring the current item to me.

@ikreymer
Copy link
Member

ikreymer commented Sep 2, 2024

Is there a reason to have the 'Viewing Workflow Crawl' label?
Screenshot 2024-09-01 at 8 27 14 PM
Wondering if it may add more confusion to have that

@SuaYoo SuaYoo marked this pull request as draft September 3, 2024 16:38
@SuaYoo
Copy link
Collaborator Author

SuaYoo commented Sep 3, 2024

Similar to how I don't think we should use the menu actions for navigation when possible, I think we should move this to the overview section along with the workflow name and a link listed the same way we list collections in the metadata section. This isn't a completely holistic take — we use the settings gear buttons in the actions section of our panels and that functions as a link — but this feels more like navigating to a different section than configuring the current item to me.

IMO the "In Collections" has always felt buried in archived item details. Having it in the metadata section seems slightly inaccurate, since information on the workflow or collection is more significant than metadata descriptors attached to the crawl.

What if we renamed "Crawl Settings" to "Workflow" and showed a primary action button in that section to "Edit Workflow"?

@Shrinks99
Copy link
Member

What if we renamed "Crawl Settings" to "Workflow" and showed a primary action button in that section to "Edit Workflow"?

Adding the edit workflow button there seems like a good addition to me!

I would be against changing the name though. The communication difference is that these are the workflow settings that the crawl ran with, not the current workflow settings. We could probably further reinforce that with a bit of descriptive text below the title... Should maybe come up with some standards for adding that in other places! I know you've already started with a few of them!

@SuaYoo SuaYoo marked this pull request as ready for review September 3, 2024 22:55
Copy link
Contributor

@tw4l tw4l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good, just some small issues with the back link from QA Review screen and looking into breadcrumb text contrast. Since I won't be in next week, approving conditional on those being addressed.

frontend/src/layouts/pageHeader.ts Outdated Show resolved Hide resolved
frontend/src/layouts/pageHeader.ts Outdated Show resolved Hide resolved
@SuaYoo SuaYoo marked this pull request as draft September 9, 2024 18:49
@Shrinks99
Copy link
Member

From today's call:

The path bar implementation is good but Archived Items living cannonically at two different paths (under both crawl workflows and archived items) isn't terribly consistent. Instead, we will double down on the crawl workflow → archived item parent/child relationship with crawls living within crawl workflows. Uploaded archived items will continue to live under /items.

Screenshot 2024-09-09 145055

@SuaYoo SuaYoo force-pushed the frontend-archived-item-nav-improvements branch from 12a745a to 386f5c8 Compare September 9, 2024 21:24
@SuaYoo SuaYoo marked this pull request as ready for review September 9, 2024 21:24
@SuaYoo SuaYoo requested a review from tw4l September 9, 2024 21:24
Copy link
Member

@ikreymer ikreymer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New approach makes sense!
Only nitpick is with the crawl breadcrumb showing the finished date, should we show the crawl id?
Crawls / Finished at 08/30/24, 1:01 AM (sched-18cf78aa-abc-28750080)
or
Crawls / sched-18cf78aa-abc-28750080 (Finished at 08/30/24, 1:01 AM)
so that there's a way to relate the crawl id, which users might want for API, etc..

It is shown below, so don't feel too strongly about it one way or another and approving it as is.

@SuaYoo
Copy link
Collaborator Author

SuaYoo commented Sep 10, 2024

New approach makes sense! Only nitpick is with the crawl breadcrumb showing the finished date, should we show the crawl id? Crawls / Finished at 08/30/24, 1:01 AM (sched-18cf78aa-abc-28750080) or Crawls / sched-18cf78aa-abc-28750080 (Finished at 08/30/24, 1:01 AM) so that there's a way to relate the crawl id, which users might want for API, etc..

The crawls are currently identified by name and finished (created in archived items) date. I think it'd make sense to show a short ID if it's also how we identify the crawl in a list, otherwise I think it'd be fairly meaningless to the majority of non-API users.

@SuaYoo SuaYoo force-pushed the frontend-archived-item-nav-improvements branch from 92d44f3 to 2fd4973 Compare September 10, 2024 21:19
@SuaYoo SuaYoo merged commit b58d367 into main Sep 10, 2024
2 checks passed
@SuaYoo SuaYoo deleted the frontend-archived-item-nav-improvements branch September 10, 2024 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: QA review breadcrumbs origin
5 participants