Code Monkey home page Code Monkey logo

edx-platform's Introduction

CUCWD fork of edx-platform

This is CUCWD's fork of https://github.com/edx/edx-platform

The master branch of this repository is meaningless - do not refer to it nor use it as a base branch for changes to edx-platform. Always use the edx/edx-platform master branch as a starting point, or whatever other branch is appropriate.

We push branches here that are used for pull requests against the upstream edx-platform repository or other forks. Latest Open edX Release is helpful to see how edX releases the platform releases. When deploying releases to production we are using the version number tag release (e.g. open-release/juniper.3) rather than staying with the open release name main branch (e.g. open-release/juniper.master)

This fork also holds the cucwd branches for the edx-platform. Here is a structure on how we perform Gitflow and Pull Request (PR). Wherever it says name it should be replace with Open edX named release (e.g. juniper):

  • cu-release/name.master: changes from open-release/name.master branch + additional commits from cucwd. Not released to production instances to avoid confusion between multiple VMs in load balancer setup.
  • cu-release/name.#: changes from open-release/name.# tag + additional commits from cucwd. This is released to production instances to avoid issue with load balancer setup of having every instance look the same.
  • open-release/name.master: latest main branch of open named release. Start of cucwd development for this release. The develop.name branch is started from this release.
  • open-release/name.#: latest versioned release tag of open named release. Not used for cucwd.
  • develop.name: branched from open-release.name.master at start of release development; additional commits from feature.name/EW-###-name get committed here while in development.
  • feature.name/EW-###-name: feature work in-progress. Push to remote origin-cucwd then make a PR to develop.release.

Development Process for Open edX Release

  1. develop.name is branched from open-release/name.master to start development.
  2. feature.name/EW-###-name is branched from develop.name to start feature development for named release. Branch is pushed to remote origin-cucwd and a PR is initiated going from this branch to develop.name. Changes are reviewed then merged.
  3. Once all changes for release are completed for development a cu-release/name.master branch is created from develop.name and pushed up to remote origin-cucwd.
  4. Any commits that come after latest open-release/name.# are removed from cu-release/name.master and a tag cu-release/name.# is created. This will be the release that gets put in production.

edx-platform's People

Contributors

ztraboo avatar

Watchers

James Cloos avatar avatar avatar

edx-platform's Issues

Bug: On new course rerun or course export/import we need to also bring along the exist terms defined on the `Studio: Key Term Dashboard`.

After creating a new course re-run, you'll notice that the Studio: Key Term Dashboard page is empty. This would require us to manually import the external Excel document every time and could be overlooked by a support staff member.

It would be better to have the CMS course rerun functionality to migrate these terms over to the new course rather than having to worry about the external Excel import. This is because we may have to perform several course reruns for a new semester.

This needs to be addressed for both course re-runs and course export/imports.

Trustworks – BigCommerce – Demographic Required Fields – Skip Registration Form

After pushing an update out for registration demographic changes for the platform the BigCommerce third-party authentication did not autocomplete these fields resulting in the user having to enter additional registration fields on the platform after previously completing a registration form on the BigCommerce platform.

The BigCommerce third-party provider had Skip Registration Form enabled and therefore these additional fields needed to be autocompleted with default value of prefer-not-to-say or Null. Fields like postal_code and country_code were brought in from the BigCommerce account.

In the future it may be helpful to update the BigCommerce registration fields using this article (https://support.bigcommerce.com/s/article/Editing-Form-Fields?language=en_US) in order to get a real value for these additional demographic fields. For the time being we're just supplying a default value and not allow for additional user input when creating the EducateWorkforce account.

Merge Badging into Maple release.

Need to merge in these PR changes:

There were several commits in this PR that I didn't bring over simply for the fact that the Maple release now uses Badgr API v2. Previously, we had used code from Appsembler that handled v1 and v2 with the PR commit changes. We will see how the new Maple release code works and use that going forward.

Here were some additional changes needed for Maple.

Bug: When rerunning a course the `Key Terms` do not get loaded on the re-run course.

The example below shows the initial development course on the left with terms. When you re-run a course on the CMS dashboard you'll notice that the Key Terms Dashboard list is empty. We either need a way to export all the terms to an Excel file or click a transfer terms button to send these terms to another course.

We probably need to decide whether we want the terms to come across to the new course or not automatically. For example if we exported the course and gave it to another LMS system (e.g. AIM Photonics) that doesn't have our key term functionality setup. Until key terms is upstream to openedx repo we may just want to not automatically bring the terms over and provide an export functionality to Excel instead.

I put this bug on the platform repo because I believe this is where the course re-run logic runs, however, if we updated frontend-app-course-authoring to account for the key term button export then we'll need to close this issue and move it to that repo instead.

image

Bug: When performing a `CMS > Course > Reindex` it fails early and not all the key terms located within the textbook are indexed.

Issue

When performing a CMS > Course > Reindex on a course, I noticed that the key terms textbook indexing failed to complete, however, I didn't notice much output coming from the browser console or server logs for keyterms and cms services.

image

Development

Use this course https://cms.educateworkforce.com/course/course-v1:CUCWD+FAA-ACS-AM-IIG-ECS+DEVELOPMENT in your tutor dev environment and the key terms Excel document below to test.

Environmental Control Systems Key Terms.xlsx

Steps to Reproduce Issue

Make sure that you have key terms api, xblock, and edx-platform changes necessary to run key terms locally before proceeding further.

  1. Import all the key terms using the Excel file above at CMS > Course > Content > Key Terms Dashboard.
  2. Make sure that the CMS > Course > Settings > Advanced Settings > Advanced Module List has value [ "keyterms"] to be able to use the Key Terms course component.
  3. Add a new Key Terms course component to any vertical (unit) page and try selecting terms, then Publish the page.
  4. Add a textbook to the course at CMS > Course > Content > Textbooks. For this course you can add the following.
- Textbook Name: Aircraft System Maintenance
- Chapter Name: Cabin Environmental Systems
- Chapter Asset: /static/Avotek_Chapter_2_Environmental_Control_Systems_EW.pdf
  1. Perform a CMS > Course > Reindex and see if it crashes. Look at the log files for keyterms and cms to see output.
  2. Double check that most key terms have Textbook links in the CMS > Course > Key Terms Dashboard page.

Temporary Work Around
I did notice that when I clicked Publish on the individual Vertical (Unit) page that the Textbook links appeared for the terms on that page. Not sure if this Publish limits the indexing of the terms based on what's in the Key Terms course component or if it does the whole list of terms for the course.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.