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.

Sign up for GitHub

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

docs: consistency in commands and the need for themes root DS-728 #56

Merged
merged 1 commit into from
Jan 3, 2024
+12 −2
Merged

docs: consistency in commands and the need for themes root DS-728 #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading