search

overhangio / tutor-indigo

An elegant, customizable theme for Open edX
GNU Affero General Public License v3.0
74 stars 276 forks source link

It's not clear how to implement a new theme #44

Closed throwaway-a closed 9 months ago

throwaway-a commented 1 year ago

I lost a couple hours today brute forcing combinations of tutor commands to try and find the correct way to get changes to appear near-immediately within a tutor instance (I'm not sure why sometimes they took a few minutes after launch before they were reflected, but perhaps it was a Google Chrome cache issue.)

I finally landed on the following set of commands to explicitly apply changes after they were made from within the theme folder:

tutor config save
tutor images build openedx
tutor local launch

Please update the Configuration or Customization sections of the documentation to explicitly state this is the correct way to apply new changes to the theme.

Also the documentation of "This plugin can serve as a starting point to create your own themes. Just fork this repository and modify the files as you see fit." is incomplete to the point of incorrectness. But I was able to follow the steps from here to create my own-named theme (so I could confirm it's what was actually being used). It'd be good if you could extract the important bits from those steps and add them to the documentation too.

Edim7 commented 10 months ago

I am also having issues with editing a theme and not seeing changes on the site. Furthermore, when I make changes to indigo and I do tutor config save I get all of my changes overwritten and reverted to the default state of indigo.

I'm guessing this has to do with the config, but I just wanted to say that further clarification of working with themes would be much appreciated.

hinakhadim commented 9 months ago

Thank you for sharing your experience with the tutor-indigo. The steps has been updated in the documentation. @regisb can we close this issue as #49 has been merged.