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.

Sign up for GitHub

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

Jump to bottom

feat: shareable URLs for library components and searches [FC-0076] #1575

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

feat: shareable URLs for library components and searches [FC-0076] #1575

wants to merge 3 commits into from

Conversation

pomegranited
Copy link
Contributor

Description

Describe what this pull request changes, and why. Include implications for people using this change.
Design decisions and their rationales should be documented in the repo (docstring / ADR), per

Useful information to include:

  • This change makes it possible for Content Authors to share URLs for a specific component, collection, and/or set of library content search parameters.
  • No change to the UI -- only improves the URLs.

Use cases covered (some still to do):

  • As an author working with content libraries, I want to easily share any component in a library with other people on my team, by copying the URL from my browser and sending it to them.
  • As an author working with content libraries, I want to easily share any search results with other people on my team, by copying the URL from my browser and sending it to them.
  • As an author working with content libraries, I want to bookmark a search in my browser and return to it at any time, with the same filters and keywords applied.
  • As an author of a content library with public read access, I want to easily share any component in a library with any authors on the same Open edX instance, by copying the URL from my browser and sending it to them.
  • As an author of a content library, I want to easily share a library's "Manage Team" page with other people on my team by copying the URL from my browser and sending it to them.
  • As an author working with content libraries, I want to easily share any selected sidebar tab with other people on my team, by copying the URL from my browser and sending it to them.

Supporting information

See #1499
Private-ref: FAL-3984

Testing instructions

Please provide detailed step-by-step instructions for testing this change.

TBD -- include content picker checks too.

@pomegranited
fix: use generatePath in testUtils
aa25827 
to support optional parameters in test paths
@pomegranited
feat: adds sharable URLs for library components/collections
8706bf6 
* Restructure LibraryLayout so that LibraryContext can (optionally)
  useParams() to initialize its componentId/collectionId instead of
  having to parse route strings.

  This behavior can be disabled for the content pickers by passing
  initializeFromUrl={false} to the LibraryContext.

* Add useLibraryRoutes() hook so components can easily navigate to the
  best available route without having to know the route strings or
  maintain search params.

  Also moved ContentType declaration to the new routes.ts to avoid
  circular imports.

* Clicking/selecting a ComponentCard/CollectionCard navigates to an
  appropriate component/collection route given the current page.

* Rename openInfoSidebar to openLibrarySidebar, so that openInfoSidebar
  can be used to open the best sidebar for a given
  library/component/collection.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 18, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @pomegranited!

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

🔘 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.

@pomegranited
feat: store search keywords and sidebar tab in URL search params
8fdbe9b 
Also moves useStateWithUrlSearchParam into hooks.ts so it can be used
outside of SearchManager.
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Waiting on Author
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pomegranited @openedx-webhooks @mphilbrick211