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

(DS-451)feat: adds TenantAwareLinkRenderStarted filter #179

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

JuanDavidBuitrago
Copy link
Member

@JuanDavidBuitrago JuanDavidBuitrago commented Mar 31, 2023

Description

This PR adds a custom filter pipeline to get LMS_ROOT_URL value for org from tenant site.

The idea is including some changes in openedx-filters and edx-platform repositories to anyone implement the filter function, and one clear example to use is this custom pipeline on eox-tenant plugin.

Dependencies:

Testing instructions

  1. In a Nutmeg or Olive environment, install the plugin with the changes in openedx/edx-platform and openedx/openedx-filters branches. Use the Tutor instructions to install the eox-tenant django plugin with the changes in this branch.
# Clone repo
git clone git+https://github.com/eduNEXT/eox-tenant.git "$(tutor config printroot)/env/build/openedx/requirements/"
# Change branch
git checkout JDB/add_tenant_aware_filter
# Adds path to private.txt
echo "./eox-tenant" >> "$(tutor config printroot)/env/build/openedx/requirements/private.txt"
  1. Create a Tenant and import a certificate course (You need to create a tenant for Studio too). Go on to create sites: http://lms.nutmeg.edunext.link:8000/admin/eox_tenant/tenantconfig/

  2. Add the following configurations to your configuration site and Studio tenant.

"OPEN_EDX_FILTERS_CONFIG": {
                "org.openedx.learning.tenant_aware_link.render.started.v1": {
                    "fail_silently": false,
                    "pipeline": [
                        "eox_tenant.filters.pipeline.FilterTenantAwareLinksFromStudio"
                    ]
                }
            },
  1. Now Go to Content -> course outline, click on the “View live” button, which should direct you to the URL of the specific tenant (what is configured in SITE_NAME)
  2. Go to Settings-> Schedule & Details, click on the “Course Summary Page” link, which should direct you to the URL of the specific tenant
  3. Verify that the link of the "Invite your students" button in the body refers to the URL of the specific tenant
  4. Also check for a link to a course summary below the “course overview” text box.
  5. Go to Content -> Files & uploads, verify the absolute links of any asset (In the Web button), which should lead to the URL of the specific tenant
  6. Go to Settings -> Certificates and click on the “Preview certificate” button, which should point to the URL of the specific tenant. It doesn't matter if what it loads isn't pretty, as long as it's the correct URL.

Additional information

Checklist for Merge

  • Tested in a remote environment
  • Updated documentation
  • Rebased master/main
  • Squashed commits

@Alec4r Alec4r self-requested a review March 31, 2023 13:07
@JuanDavidBuitrago JuanDavidBuitrago force-pushed the JDB/add_tenant_aware_filter branch 3 times, most recently from 45635db to 2bf1172 Compare April 3, 2023 10:00
@JuanDavidBuitrago JuanDavidBuitrago marked this pull request as ready for review April 3, 2023 13:20
@JuanDavidBuitrago JuanDavidBuitrago marked this pull request as draft May 30, 2023 10:53
@MaferMazu
Copy link
Contributor

@JuanDavidBuitrago, do you still want to work on this, or we can close this PR?

@JuanDavidBuitrago
Copy link
Member Author

@JuanDavidBuitrago, do you still want to work on this, or we can close this PR?

Yes, I want to work on it. I first need to solve some issues in those PRs:
openedx/edx-platform#32014
openedx/openedx-filters#77

@Asespinel
Copy link
Contributor

@JuanDavidBuitrago Do we have an update on the PPs mentioned above?

@JuanDavidBuitrago
Copy link
Member Author

No, I haven't been able to work on this to fix it

@github-actions github-actions bot added the size/s label Sep 6, 2023
@JuanDavidBuitrago JuanDavidBuitrago force-pushed the JDB/add_tenant_aware_filter branch 2 times, most recently from bdedf03 to 2bf1172 Compare September 7, 2023 00:37
@jignaciopm jignaciopm marked this pull request as ready for review July 25, 2024 03:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants