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

Library component sidebar: List courses that are using this component #1564

Open
Tracked by #1097
bradenmacdonald opened this issue Dec 10, 2024 · 6 comments
Open
Tracked by #1097
Labels
enhancement Relates to new features or improvements to existing features

Comments

@bradenmacdonald
Copy link
Contributor

bradenmacdonald commented Dec 10, 2024

As a library content author, I want to see the list of courses in which my team's library components are being used.

mockup

@bradenmacdonald bradenmacdonald added the enhancement Relates to new features or improvements to existing features label Dec 10, 2024
@bradenmacdonald bradenmacdonald moved this to In grooming in Libraries Overhaul Dec 10, 2024
@bradenmacdonald
Copy link
Contributor Author

@sdaitzman @jmakowski1123 @marcotuts Is this the latest mockup? Should we show breadcrumbs (which unit the content is being used in) or just the course name? When clicking on the link, should it take you to the unit where it is used? Should we indicate on this list if the usage in each course is out of date or not, if possible? How should we indicate if the current user doesn't have permission to see the course? CC @navinkarkera

@navinkarkera
Copy link
Contributor

@sdaitzman @jmakowski1123 @marcotuts Gentle reminder.

@jmakowski1123
Copy link

jmakowski1123 commented Feb 18, 2025

Thanks for flagging @navinkarkera

  1. Yes, this can be the latest mockup. Implementation can be simple, just the course name in font that aligns with the rest of the sidebar.
  2. Just the course name is fine for Teak.
  3. On clicking, if it's possible to take the user to the unit where it is used, that's ideal. Lmk if there is extra effort required for this.
  4. Not sure what you mean by "out of date". My assumption is that if the component is no longer being used in a course, then the course name is removed/de-listed from the sidebar. If there are new edits to the component that require syncing, the user will see the sync icon displaying anyway when they land on the unit page.
  5. If the user doesn't have permission to view the course, can we use a default error Studio landing page that already exists for situations when authors get urls to courses that they are not staff on?

@navinkarkera
Copy link
Contributor

@jmakowski1123 Thanks!

@rpenido I think we have everything ready except for point 3 from above comment, i.e. taking user to the unit where it is used. Would like to handle it as part of this task?

@jmakowski1123 Is it fine to take the user to the first unit that is using this component in case the same component is used multiple times in the same course?

@rpenido
Copy link
Contributor

rpenido commented Feb 19, 2025

@jmakowski1123

On clicking, if it's possible to take the user to the unit where it is used, that's ideal. Lmk if there is extra effort required for this.

This is not currently implemented, but it requires little effort. Also, it won't be hard to list the units where the component is used (instead of the Course), as in the image below.

Image

Let us know what you think!

@navinkarkera I can handle it as part of this task.

@jmakowski1123
Copy link

If it's little effort to both go to the unit, and to list the units under the course name, that's great. It's fine to redirect to the first unit where the component is used, if it's used multiple times.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Relates to new features or improvements to existing features
Projects
Status: In grooming
Development

No branches or pull requests

4 participants