-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: consistency in commands and the need for themes root (#56)
- Loading branch information
Showing
1 changed file
with
13 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,7 +9,7 @@ This can be watch like a tutor-plugin but is taken a little bit far away. | |
## Installation | ||
|
||
```bash | ||
pip install git+https://github.com/eduNEXT/tutor-contrib-edunext-distro@v15.2.0 | ||
pip install git+https://github.com/eduNEXT/tutor-contrib-edunext-distro | ||
``` | ||
|
||
## Usage | ||
|
@@ -18,12 +18,12 @@ pip install git+https://github.com/eduNEXT/[email protected] | |
tutor plugins enable distro | ||
|
||
# Validator commands for config file | ||
tutor distro syntax_validator | ||
tutor distro syntax-validator | ||
tutor distro repository-validator | ||
|
||
# Enabler commands | ||
tutor distro enable-themes | ||
tutor distro enable_private_packages | ||
tutor distro enable-private-packages | ||
``` | ||
|
||
### Documentation | ||
|
@@ -146,6 +146,16 @@ DISTRO_THEMES_NAME: | |
- bragi | ||
``` | ||
Set themes root (which is where the theme will be installed): | ||
When you set the ``DISTRO_THEMES_ROOT``, the theme will be in your ``<tutor_root>/env/build<distro_themes_root>``. | ||
```yaml | ||
DISTRO_THEMES_ROOT: /openedx/themes | ||
``` | ||
In the previous example, the theme will be in ``env/build/openedx/themes`` when you execute the ``enable-themes`` command. | ||
Run the command to clone the themes: | ||
```bash | ||
|