Skip to content
This repository was archived by the owner on Aug 3, 2026. It is now read-only.

[SE-3381] Allows adding new tinymce plugins through platform configuration - #143

Merged
nizarmah merged 11 commits into
opencraft-release/juniper.3from
nizar/tinymce_plugins_role_backport
Jan 3, 2021
Merged

[SE-3381] Allows adding new tinymce plugins through platform configuration#143
nizarmah merged 11 commits into
opencraft-release/juniper.3from
nizar/tinymce_plugins_role_backport

Conversation

@nizarmah

@nizarmah nizarmah commented Nov 29, 2020

Copy link
Copy Markdown

This makes it possible to install new tinymce plugins through the environment settings.

This PR is responsible for adding the tinymce plugins to the plugins directory and rebuilding the assets.

JIRA tickets: SE-3381, SE-3247

Dependencies:

Upstream Pull Request:

Sandbox URL:

Testing instructions:

  1. Login to Studio using staff@example.com/edx
  2. Create a new Unit with an HTML Text
  3. Make sure that the ADSK Link shows in the toolbar
  4. Create a link and make sure you can preview it, and see it on the LMS

Reviewers

Settings

EDXAPP_CMS_ENV_EXTRA:
  JS_ENV_EXTRA_CONFIG:
    TINYMCE_ADDITIONAL_PLUGINS:
      adsklink:
        linktypes:
        - download
        - offer
        filetypes:
        - PDF
        - zip
        - Video
        - Design
        orientations:
        - Vertical
        - Horizontal
        styles:
        - Primary
        - Normal
        - Secondary

TINYMCE_ADDITIONAL_PLUGINS_LIST:
- repo: https://gitlab.com/nizarmah/tinymce-adsk-plugin
  name: adsklink
  plugin_path: "/adsklink"

edx_ansible_source_repo: "https://github.com/open-craft/configuration.git"
configuration_version: "nizar/tinymce_plugins_role_backport"
edx_platform_commit: "nizar/tinymce-easy-plugin-modification-backport"

Make sure that the following steps are done before merging:

  • A DevOps team member has approved the PR if it is code shared across multiple services and you don't own all of the services.
  • Are you adding any new default values that need to be overridden when this change goes live? If so:
    • Update the appropriate internal repo (be sure to update for all our environments)
    • If you are updating a secure value rather than an internal one, file a DEVOPS ticket with details.
    • Add an entry to the CHANGELOG.
  • If you are making a complicated change, have you performed the proper testing specified on the Ops Ansible Testing Checklist? Adding a new variable does not require the full list (although testing on a sandbox is a great idea to ensure it links with your downstream code changes).
  • Think about how this change will affect Open edX operators. Have you updated the wiki page for the next Open edX release?

Comment thread playbooks/roles/tinymce_plugins/tasks/import_tinymce_plugin.yml
Comment thread playbooks/roles/tinymce_plugins/tasks/rebuild_tinymce_files.yml Outdated
Comment thread playbooks/openedx_native.yml Outdated
@pkulkark

pkulkark commented Dec 2, 2020

Copy link
Copy Markdown
Member

@nizarmah It looks like the styling is not getting applied inside the html editor or in LMS of the sandbox. But it's loading correctly in Studio. This comment might help understand what css file gets loaded when. Maybe you missed a step somewhere? Or missed applying the theme?

@nizarmah

nizarmah commented Dec 2, 2020

Copy link
Copy Markdown
Author

@pkulkark I've been investigating this for a while now. I just realized that there's a separate theme related change for this tinymce plugin specifically. Here's the commit I am talking about.

I'm currently trying to make the platform include the stylesheets 👀
Let's hope this works out and people don't need to add the styles manually 🤞

@nizarmah

nizarmah commented Dec 2, 2020

Copy link
Copy Markdown
Author

@pkulkark small note, we might want to continue this conversation on this pull request instead, since it is more related to the edX platform than the configuration.

@pkulkark pkulkark left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@nizarmah The changes LGTM 👍

  • I tested this: verified the feature works as expected in the sandbox deployed using this config.
  • I read through the code

@nizarmah
nizarmah force-pushed the nizar/tinymce_plugins_role_backport branch 3 times, most recently from 9345eda to 4b2d00d Compare December 18, 2020 11:58
@nizarmah
nizarmah force-pushed the nizar/tinymce_plugins_role_backport branch from 4b2d00d to 108f174 Compare December 28, 2020 00:06

@nizarmah nizarmah left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

👍🏼

I'll be merging the changes.

  • Changes are being reviewed upstream
  • Addressed first set of comments on upstream pull request
  • Tested the new changes on the sandbox instance
  • Pull request was already reviewed by another member

If any changes are requested upstream, we can revert, and re-apply the changes.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants