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

[Tagging] Create Taxonomies List Page (in Course Authoring MFE) #104

Closed
bradenmacdonald opened this issue Sep 19, 2023 · 8 comments · Fixed by openedx/frontend-app-authoring#622

Comments

@bradenmacdonald
Copy link
Contributor

bradenmacdonald commented Sep 19, 2023

"As any user with access to Studio, I can see the new "Taxonomy" tab, which has the Taxonomy List Page. It displays any taxonomies that are enabled for my organization, as well as system-defined Taxonomies."

Screenshot 2023-09-27 at 12 16 50 PM

Acceptance criteria:

  1. Add a new link from Studio Home to this taxonomies list. (Alongside "Courses", "Libraries"). This should be hidden behind a new feature flag for now.
  2. This should be part of frontend-app-course-authoring.
  3. As always, follow standard practices - Paragon, i18n, a11y, etc.
  4. Taxonomies do not (yet) need to be clickable - no details available, no edit functionality (those come in subsequent stories)
  5. For now, just show whatever taxonomies the API returns for the current user, without regard to whether they're system-defined or part of a specific org or disabled/enabled.
  6. UPDATED: If a taxonomy is not "enabled" according to the API, hide it altogether.
  7. UPDATED: If a taxonomy is "system defined" according to the API, display the "System-defined" badge:
    Screenshot 2023-10-11 at 2 26 58 PM
  8. UPDATED: The three dots menu ⋮ will come in a later story - for now it can be omitted entirely.
  9. If the description of the taxonomy is super-long, the text must be truncated with an ellipsis (see mockups).
  10. The header is out of scope for now. Until it is available (until another team has implemented the new header, or we do so in a later phase [Tagging] Implement New Header [Postponed] #119), use no header and just a link back to the Studio home page.
    Screenshot 2023-09-27 at 12 17 12 PM
  11. UPDATED: Include a link to the documentation about Taxonomies. If available. If not, create a future story to track this TODO. (don't worry about this for now)
  12. Deploy the changes to the tagging sandbox and enable the feature flag for all users.

Developer notes:

  • Screenshots above are for convenience - Figma is the most up-to-date source for mockups. The scale of UI elements seen in the screenshots above may be incorrect.
  • If possible, I'd prefer that we Use TypeScript and React-Query for accessing data from the Taxonomy API
  • [Tagging] Sample taxonomy and org data #107 should provide sample data, as there is no CRUD functionality in the UI yet.
  • Important: The cards will be very similar to the code for cards from the Studio Pages & Resources page since they're almost identical in appearance. Re-use or copy code from that where it makes sense. The Taxonomy list should probably be a Paragon CardView so we can get pagination and filtering in the future. (For now, hide its search/filter/page components and display all taxonomies at once.)
    Screenshot 2023-09-30 at 4 25 26 PM
@bradenmacdonald
Copy link
Contributor Author

@KristinAoki @arbrandes - do you think this new "Taxonomy" section of Studio should be part of frontend-app-course-authoring or be a new independent MFE?

@muselesscreator Is the "Typescript and React-Query" stuff far enough along for us to use it for data loading in this new MFE?

@bradenmacdonald bradenmacdonald changed the title Create Taxonomy MFE - list taxonomies [Tagging] Create Taxonomy MFE - list taxonomies Sep 19, 2023
@arbrandes
Copy link

Given that there more than a few practical reasons for minimizing the number of MFEs (at least as they exist at time of writing), IMHO making this part of the Course Authoring repo is the way to go.

@KristinAoki
Copy link
Member

Makes sense to me that it should be part of the course authoring MFE! Is this going to become part of the home page?

@bradenmacdonald
Copy link
Contributor Author

@KristinAoki I'm not sure, it depends if 2U is refactoring the global Studio header to include the main tabs like "Courses", "LIbraries", etc. or not. Basically wherever you choose "Courses" or "Libraries" tabs, there will be a new third tab called "Taxonomies" that will open this new app. That may be either on the home page or the global header... in the UX mockups from @ali-hugo that you see above, it looks like they're in the global header, but in Studio today those are on the home page.

@bradenmacdonald bradenmacdonald changed the title [Tagging] Create Taxonomy MFE - list taxonomies [Tagging] Create Taxonomy MFE & Taxonomies List Page Sep 22, 2023
@ali-hugo
Copy link

@bradenmacdonald Thanks for creating this ticket! Just a quick question on about the following note in the description:

...If no taxonomies are shown, display the empty state message from the mockup.

Is this still relevant now that we've determined that users will never see an empty list because there will always be system taxonomies listed?

@bradenmacdonald
Copy link
Contributor Author

@ali-hugo I thought I had removed that but I guess I missed it. Updated :)

@ali-hugo
Copy link

@bradenmacdonald @ChrisChV When testing out the Taxonomies page, I expected to be able to hover over the truncated card title, and see a tooltip displaying the full text (see mockup below).

truncated card title

I'm not sure whether this has been implemented in Paragon, but perhaps it should. What do you think?

@bradenmacdonald
Copy link
Contributor Author

^ We will fix the above shortly in FAL-3537.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging a pull request may close this issue.

4 participants