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

Component Sidebar: Details Tab #1195

Open
jmakowski1123 opened this issue Jul 30, 2024 · 5 comments
Open

Component Sidebar: Details Tab #1195

jmakowski1123 opened this issue Jul 30, 2024 · 5 comments

Comments

@jmakowski1123
Copy link

To be completed after: #1045

  1. The Details Tab contains a free-text field for users to enter a description of the content.
  2. Field for content type
  3. Links to courses where the component is being used
  4. Time stamp for last modified
  5. Time stamp for created

Image

Out of scope: The "Creator" of the component is excluded for now (not stored anywhere) discussion

@rpenido
Copy link
Contributor

rpenido commented Aug 7, 2024

Hi @bradenmacdonald!

  1. Links to courses where the component is being used

Just to confirm, I think this is out of scope for Epic 3.
We need #1185 to have this info, right?

@bradenmacdonald
Copy link
Contributor

@rpenido That's right.

@rpenido
Copy link
Contributor

rpenido commented Sep 17, 2024

Hi @bradenmacdonald! I have another doubt that I want to confirm here:

  1. The Details Tab contains a free-text field for users to enter a description of the content.

It doesn't seem that the XBlock has a description field, and currently, we are rendering the content in the Component Card.
Should we change it and use a new description meta field?

@bradenmacdonald
Copy link
Contributor

@rpenido Yes, the plan was to have the description field that can override the one that comes from the content. Setting the description doesn't change the XBlock [fields] at all - it's only a change in the library metadata.

But I think we thought at the time that ComponentVersion had a description field and now I see that it doesn't. @ormsbee or @kdmccormick do you remember what we discussed about this? Should we add a description field to Component or ComponentVersion or punt this for now?

@ormsbee
Copy link

ormsbee commented Sep 18, 2024

Asked for clarifications in Slack, but my off-the-cuff take is that the description is a field on a new model that's 1:1 with Component–mostly because a lot of queries will potentially join against Component, and I'd be worried about the descriptions text coming across the wire by default for all of them. (I realize we can defer fields in the queryset, but I worry about other things that hang off of ComponentVersion not realizing how careful they have to be about that in their RelatedManagers.)

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

No branches or pull requests

4 participants