Improved taxonomy badges

[bradenmacdonald]

Description

This is a proposal (and WIP implementation - still needs polish and tests) to improve the display of the taxonomies list, based on the current properties of taxonomies in the system today.

Before

After

Notes

There are no changes to the backend; this just updates the UI to:

1. Show the actual organization that a taxonomy is assigned to (or all orgs or "N orgs")
2. Show the "advanced" taxonomy features that can be enabled via the Django admin, like allowing only a single tag per entity or creating a "free text" taxonomy (not fully implemented, but you can still toggle this option and it does affect some things, so it's useful to indicate in the UI).
3. If a taxonomy has been "disabled", it won't show on the taxonomy list, but you can still access it by URL, if you saved the URL. Before this change,

Disabled taxonomy:

Before	After

Note that "Disabled" now shows in the UI, whereas before there would be no indication why this taxonomy appears normal on this page, but is hidden everywhere else.

Testing instructions

View the taxonomy list page. Use the Django admin to change the advanced settings of taxonomies and see the labels change.

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

• Any new files are using TypeScript (.ts, .tsx).
• Avoid propTypes and defaultProps in any new or modified code.
• Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
• Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
• Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
• All new i18n messages in messages.ts files have a description for translators to use.
• Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

[openedx-webhooks]

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @bradenmacdonald.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

---

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[jmakowski1123]

There is a similar/same ticket to do this here - we need to make sure we align on a unified design choice: openedx/openedx-core#616

[edschema]

I love surfacing more info on the taxonomy cards.

One suggestion based on an assumption: I assume organization is a more important (or at least a functionally different type of metadata) than info like single-tag only or system-level, etc. If this is true, we may want to pull that out of a badge and have it as a sub heading, something like:

[jmakowski1123]

What is the full list of possible metadata that could be included here?

[bradenmacdonald]

@jmakowski1123

What is the full list of possible metadata that could be included here?

• Internal ID (not useful)
• Name
• Description
• Enabled/disabled (when disabled, it's hidden from the taxonomy list)
• allow_multiple - Indicates that multiple tags from this taxonomy may be added to the same object.
• allow_free_text - not really used yet. "Indicates that tags in this taxonomy need not be predefined; authors may enter their own tag values."
• visible_to_authors - "Indicates whether this taxonomy should be visible to object authors."
• export_id - ID for cross-instance/cross-institution taxonomy matching
• read_only - prevents edits of the tags from the taxonomy editor UI. Metadata may still be editable including turning off the read_only flag. This works but is only partially implemented in the UI.
• # of tags in the taxonomy
• max depth of the taxonomy
• # of objects tagged using this taxonomy
• Associated orgs

[bradenmacdonald]

@edschema @jmakowski1123 Could you let me know how you'd like this to move forward?