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

[FC-0059] Components tab #1109

Merged

Conversation

ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Jun 13, 2024

Description

This PR adds:

  • Library components card
  • Card Grid in Library Home - Components tab.
  • Connect with API to get library components.

Supporting information

Testing instructions

  • Enable library authoring in your tutor.
  • Go to the library authoring and create an new library
  • In library authoring create components, more that 40 to test Infinite scroll. TODO Fixtures to create test content?
  • Edit a title and description of a component to be long.
  • Run tutor dev run cms bash and ./manage.py cms reindex_studio --experimental.
  • Go to the library home using the id of your new library: http://apps.local.edly.io:2001/course-authoring/library/{library-id}
  • Go to componentas tab
  • Check that the components cards are loaded.
  • Check that the cards match with designs. Check that long title and log description are truncated.
  • Scroll down and check the infinite scroll.

Settings

EDX_PLATFORM_REPOSITORY: https://github.com/open-craft/edx-platform.git
EDX_PLATFORM_VERSION: taxonomy-sandbox-20240614

GROVE_REDIRECTS:
 - domain: {{ LMS_HOST }}
 - domain: cms.{{ LMS_HOST }}
 - domain: app.{{ LMS_HOST }}
 - domain: meilsearch.{{ LMS_HOST }}

PLUGINS:
- mfe
- grove
- s3
- meilisearch

Tutor requirements

git+https://github.com/overhangio/tutor.git@nightly
git+https://github.com/overhangio/tutor-discovery.git@nightly
git+https://github.com/overhangio/tutor-ecommerce.git@nightly
git+https://github.com/overhangio/tutor-xqueue.git@nightly
git+https://github.com/overhangio/tutor-forum.git@nightly
git+https://gitlab.com/opencraft/dev/tutor-contrib-grove.git@main

git+https://github.com/open-craft/tutor-mfe.git@7d1e1e0dad2c0e4247a4fd8280c257f13ed28432
git+https://github.com/open-craft/tutor-contrib-s3.git@04c7491442fa231e79840995f1f8707eed6353fd

@ChrisChV ChrisChV requested a review from a team as a code owner June 13, 2024 01:43
@openedx-webhooks
Copy link

openedx-webhooks commented Jun 13, 2024

Thanks for the pull request, @ChrisChV!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

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:

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 13, 2024
@ChrisChV ChrisChV marked this pull request as draft June 13, 2024 01:43
@ChrisChV ChrisChV force-pushed the chris/FAL-3757-components-tab branch from 0cd2193 to 0843a1e Compare June 21, 2024 00:21
@ChrisChV ChrisChV changed the title Components tab [FC-0059] Components tab Jun 26, 2024
Copy link

codecov bot commented Jun 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.68%. Comparing base (3a14141) to head (1ebe818).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1109      +/-   ##
==========================================
- Coverage   92.68%   92.68%   -0.01%     
==========================================
  Files         693      693              
  Lines       12346    12342       -4     
  Branches     2661     2699      +38     
==========================================
- Hits        11443    11439       -4     
  Misses        872      872              
  Partials       31       31              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ChrisChV ChrisChV force-pushed the chris/FAL-3757-components-tab branch from 0a962a0 to 32838a3 Compare July 11, 2024 08:29
@ChrisChV ChrisChV force-pushed the chris/FAL-3757-components-tab branch from 02017e4 to 7a2e82b Compare July 11, 2024 11:32
src/generic/block-type-utils/constants.ts Outdated Show resolved Hide resolved
src/library-authoring/components/ComponentCard.scss Outdated Show resolved Hide resolved
src/library-authoring/components/ComponentCard.scss Outdated Show resolved Hide resolved
src/library-authoring/components/ComponentCard.tsx Outdated Show resolved Hide resolved
src/library-authoring/components/LibraryComponents.tsx Outdated Show resolved Hide resolved
src/library-authoring/components/LibraryComponents.tsx Outdated Show resolved Hide resolved
src/library-authoring/components/LibraryComponents.tsx Outdated Show resolved Hide resolved
src/library-authoring/data/api.ts Outdated Show resolved Hide resolved
src/library-authoring/data/apiHook.ts Outdated Show resolved Hide resolved
@bradenmacdonald
Copy link
Contributor

@rpenido Can you please test this PR and confirm that it's working? @ChrisChV can you please update it with master?

Then I can approve and merge.

@rpenido
Copy link
Contributor

rpenido commented Jul 17, 2024

I found a small bug while rendering the card with a match:
image

The __meili-highlight__ tag shows instead of highlighting the text.

@ChrisChV
Copy link
Contributor Author

ChrisChV commented Jul 19, 2024

@rpenido Updated 166ab04

I will update with master

Updated with master

@bradenmacdonald bradenmacdonald merged commit 77135cd into openedx:master Jul 23, 2024
7 checks passed
@openedx-webhooks
Copy link

@ChrisChV 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@ChrisChV ChrisChV deleted the chris/FAL-3757-components-tab branch July 23, 2024 15:24
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants