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

feat: add usage_key for breadcrumbs in search index [FC-0049] #34535

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Apr 17, 2024

Description

This PR adds the usage_key for each item in the block breadcrumbs of an index document. This will allow us to have information on the parent to redirect to the right page in the Search Modal.

More Information:

Part of:

Testing Instructions

  1. Run your local stack on this branch
  2. Make sure you have meilisearch setup locally, follow the setup instructions here https://github.com/open-craft/tutor-contrib-meilisearch, but use the following branch for the plugin (https://github.com/rpenido/tutor-contrib-meilisearch/tree/rpenido/fal-3693-pass-meilisearch-enabled-env-to-mfe-config) to make sure the MEILISEARCH_ENABLED is configured in the MFEs.
  3. Run tutor dev run cms bash and ./manage.py cms reindex_studio
  4. Access http://meilisearch.local.edly.io:7700/ and check if the created documents have the usage_key field

Private ref: FAL-3709

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 17, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Apr 17, 2024

Thanks for the pull request, @rpenido! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@rpenido rpenido force-pushed the rpenido/fal-3709-add-parent-info-to-search-index branch from 689bf33 to 843adaf Compare April 19, 2024 14:47
@rpenido rpenido closed this Apr 19, 2024
@rpenido rpenido force-pushed the rpenido/fal-3709-add-parent-info-to-search-index branch from 843adaf to 6ea123d Compare April 19, 2024 14:55
@openedx-webhooks
Copy link

@rpenido Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

@rpenido rpenido reopened this Apr 19, 2024
@rpenido rpenido force-pushed the rpenido/fal-3709-add-parent-info-to-search-index branch from 02c2d58 to 3cdfab2 Compare April 19, 2024 15:40
@rpenido rpenido force-pushed the rpenido/fal-3709-add-parent-info-to-search-index branch from 3cdfab2 to 1487072 Compare April 19, 2024 17:04
@rpenido rpenido changed the title feat: add usage_key for breadcrumbs in search index feat: add usage_key for breadcrumbs in search index [FC-0049] Apr 19, 2024
@rpenido rpenido marked this pull request as ready for review April 19, 2024 19:34
Copy link
Contributor

@ChrisChV ChrisChV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rpenido Looks good! 👍

  • I tested this: I followed the testing instructions
  • I read through the code and considered the security, stability and performance implications of the changes.
  • Includes tests for bugfixes and/or features added.

@rpenido
Copy link
Contributor Author

rpenido commented Apr 22, 2024

Thank you @ChrisChV!
Could you review/merge this @bradenmacdonald?

@rpenido rpenido requested a review from bradenmacdonald April 22, 2024 14:47
@rpenido
Copy link
Contributor Author

rpenido commented Apr 24, 2024

Hi @bradenmacdonald! This is ready for another review

@bradenmacdonald
Copy link
Contributor

Looks good! I'll merge when I can.

@bradenmacdonald bradenmacdonald merged commit 7fc6cd6 into openedx:master Apr 25, 2024
66 checks passed
@bradenmacdonald bradenmacdonald deleted the rpenido/fal-3709-add-parent-info-to-search-index branch April 25, 2024 18:00
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants