Tutor FAQs for Documentation

In today’s Documentation WG, the conversation centered around the Tutor docs and how Tutor docs and docs.openedx.org live together and support each other.

Not all questions were answered but a shared action item was trying to document (or point to existing docs for) the most commonly asked FAQs around Tutor. A loose goal at this point is to determine a Tutor superuser who can answer these FAQs and have the documentation WG transform them into searchable written docs.

Add your own FAQs here.

Format is

Title

Additional Details and links

I’ll add that it would be helpful, as well, for people to post FAQ’s they’ve previously had and answers to the questions, if you’ve discovered the answer already. Any internal documentation you have - notes on stickies even - that you’d like to see rendered in the public docs would be helpful!

Enabling/Disabling Feature Flags

This is documented with an example but I don’t think the example covers enough use cases or describes how to trace a feature that you want to enable through tutor. I documented my case here, but I struggled with: a) what is the right patch name (openedx-lms-common-settings & openedx-cms-common-settings) and b) when to use FEATURE as in this example vs not as in this example.

Enable a plugin

Take forum for example. The majority of new users I think want to enable this, but I can’t see it mentioned in the official tutor docs, only in old support responses. Very common use case and very easy win (“I turned something important on!”) for a new user.

Switch the Theme

I almost never switch the theme and it is documented, but I tried to test it just now by.

  1. Copying indigo theme directory to indigo2.
  2. Making a test change in the footer.index
<span class="copyright-site">Copyrights ©${datetime.now().year}. All Rights Reserved EDIT.</span>
<span class="copyright-site">Copyrights ©${datetime.now().year}. All Rights Reserved EDIT2.</span>
  1. Rebuild the openedx Docker image and use settheme to switch themes:
tutor images build openedx
tutor local do settheme indigo2

In the django admin, now indigo2 is the set theme, but my changes don’t seem reflected:

Enable Python and Javascript Xblocks

Every new Open edX install going back some time leads to this unpleasant error:

I know this is brought up in many discussion forums, but I’m still unclear if it is totally unavailable when installing via Tutor or if there is an approach to fixing. This should be clear from Tutor docs.

(In that last discuss post, seems like there is a best-practice solution for this. )