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

fix: add patches to compile and enable themes #5

Merged
merged 5 commits into from
Sep 6, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: update the readme
MaferMazu committed Aug 30, 2024

Verified

This commit was signed with the committer’s verified signature.
MaferMazu María Fernanda Magallanes
commit f4dedbd38aa81e804fc4e7b96d5255b180f988c4
25 changes: 21 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -104,18 +104,27 @@ To enable themes in your Tutor environment, follow these steps:
1. Add the necessary configuration in your Tutor environment's ``config.yml`` file:

.. code-block:: yaml


PICASSO_TUTOR_VERSION: <the version of the tutor your installation used. e.g., v18.1.1>
PICASSO_THEMES:
- name: <your_theme_name>
- name: <your_theme_repository>
repo: <your SSH URL for cloning the repo. e.g., [email protected]:yourorg/theme.git>
version: <your branch, tag o release for cloning. e.g., edunext/redwood.master>
- name: <another_theme_name>
- name: <another_theme_repository>
repo: <your SSH URL for cloning the repo. e.g., [email protected]:yourorg/another_theme.git>
version: <your branch, tag o release for cloning. e.g., edunext/redwood.blue>
PICASSO_THEMES_NAME:
- <your theme name. e.g., bragi>
- <another theme name. e.g., pearson-theme>
PICASSO_THEME_DIRS:
- <the directory where you store your themes. e.g., /openedx/themes/ednx-saas-themes/edx-platform>
- <another directory where you store your themes. e.g., /openedx/themes/openedx-themes/edx-platform>


**Note:** If your theme repository is public, you can also use the HTTPS URL in ``repo``.

**Note:** The ``PICASSO_THEMES``, ``PICASSO_THEME_DIRS`` and ``PICASSO_THEMES_NAME`` variables are lists and can have one or more elements.

2. Save the configuration with ``tutor config save``

3. Run the enable command
@@ -125,7 +134,15 @@ To enable themes in your Tutor environment, follow these steps:
# Enable themes
tutor picasso enable-themes

This command clones your theme repository into the folder that Tutor uses for themes. Documentation available at `Installing custom theme`_ tutorial.
This command will clone your theme repository into the folder that Tutor uses for themes. You can find the documentation in the `Installing custom theme`_ tutorial.

If ``PICASSO_THEMES`` is defined, the plugin will set ``ENABLE_COMPREHENSIVE_THEMING = True``.

If ``PICASSO_THEME_DIRS`` is defined, the plugin will extend the ``COMPREHENSIVE_THEME_DIRS`` by patches.

The ``PICASSO_TUTOR_VERSION``, ``PICASSO_THEME_DIRS`` and ``PICASSO_THEMES_NAME`` variables are used to compile the themes. For detailed information, see the patch `openedx-dockerfile-pre-assets <tutorpicasso/patches/openedx-dockerfile-pre-assets>`_.
MaferMazu marked this conversation as resolved.
Show resolved Hide resolved

You can set the ``PICASSO_DEFAULT_SITE_THEME`` (optional), which will be in ``DEFAULT_SITE_THEME``; if not, we will use the first element in ``PICASSO_THEMES_NAME``.
MaferMazu marked this conversation as resolved.
Show resolved Hide resolved

**Note:** Don't forget to add extra configurations in a Tutor plugin if your theme requires it.