Skip to content

Commit

Permalink
docs: add information about removed default settings from distro
Browse files Browse the repository at this point in the history
  • Loading branch information
JuanDavidBuitrago committed Jun 20, 2023
1 parent dd90643 commit 9689c0b
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 9 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ tutor distro enable-themes
Distro plugin manages a set of settings that you can configure, to know how to do that check:

- [How to custumize distro](./docs/how_to_customize_distro.rst)
- [How to override or add a new package](./docs/how_to_add_new_packages.rst)
- [How to add a new package](./docs/how_to_add_new_packages.rst)

# Required tutor settings

Expand Down Expand Up @@ -63,6 +63,7 @@ These packages will be installed in a default installation.
- eox-audit-model (DISTRO_EOX_AUDIT_MODEL_DPKG)
- eox-tagging (DISTRO_EOX_TAGGING_DPKG)
:warning: **NOTE**: From Olmo version Distro has not defaulted packages. Now it is necessary to add the packages you want in ``config.yml`` file. See [How to add a new package](./docs/how_to_add_new_packages.rst)
## How to add a new package
Expand Down Expand Up @@ -117,6 +118,8 @@ You can use the same steps that in **How to add a new package** just set the var
- DISTRO_EOX_AUDIT_MODEL_DPKG
- DISTRO_EOX_TAGGING_DPKG

:warning: **NOTE**: From Olmo version Distro has not defaulted packages. Now it is necessary to add the packages you want in ``config.yml`` file. See [How to add a new package](./docs/how_to_add_new_packages.rst)

## Disable packages

You can disable any default package following this structure in your config.yml:
Expand All @@ -129,11 +132,15 @@ Development environment take this changes with _tutor config save_ and restart,
> **Warning:** Default packages can have dependencies with other default packages or base application and disable it would break some features.
:warning: **NOTE**: From Olmo version Distro has not defaulted packages. Now it is necessary to add the packages you want in ``config.yml`` file. See [How to add a new package](./docs/how_to_add_new_packages.rst)
# Themes
Declare the path of your themes using `tutor config save --set DISTRO_THEMES_ROOT="your_path"`,
by default the themes path goes here **/openedx/themes**

:warning: **NOTE**: From Olmo version Distro has not defaulted themes path. Now it is necessary to add the themes path in ``config.yml`` file or running command above.

## Default themes

These themes will be installed in a default installation.
Expand All @@ -142,6 +149,8 @@ These themes will be installed in a default installation.

Defining a DISTRO_DEFAULT_SITE_THEME argument with a color will set a default theme, however, if not specified the default theme will be the first on the DISTRO_THEMES_NAME set of themes.

:warning: **NOTE**: From Olmo version Distro has not defaulted themes. Now it is necessary to add the themes in ``config.yml`` file. See [How to add a theme](https://github.com/eduNEXT/tutor-contrib-edunext-distro#how-to-add-a-theme).

## How to add a theme

You can override the default themes on the config.yml but
Expand Down Expand Up @@ -189,6 +198,8 @@ tutor distro enable-themes
openedx-assets themes --theme-dirs THEME_DIRS --themes THEME_NAMES
```

:warning: **NOTE**: From Olmo version Distro has not defaulted themes. Now it is necessary to add the themes in ``config.yml`` file.

# Build a new image

**requirements:** you should have enabled the distro plugin, also you had have run the commands `tutor distro enable-themes` and `tutor distro enable-private-packages`.
Expand Down
11 changes: 6 additions & 5 deletions docs/how_to_add_new_packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ How to override or add a new package

You can add or override a package directly in config.yml file (``$(tutor config printroot)/config.yaml``).

It's possible to install from a repository or by pip but take in mind, the second option couldn't install it as editable.
It's possible to install from a repository or by pip but take in mind, the second option couldn't install it as editable.

Follow the next structure:

Expand Down Expand Up @@ -48,7 +48,7 @@ To override a default package identify its name and set it like ``DISTRO_<PACKAG
An example of override eox-theming plugin:

.. code-block:: yml
DISTRO_EOX_THEMING_DPKG:
index: git
name: eox-theming
Expand All @@ -72,16 +72,17 @@ An example of override eox-theming plugin:
"from_django_settings"
]
:warning: **NOTE**: From Olmo version Distro has not defaulted packages. Now it is necessary to add the packages you want in ``config.yml`` file.

Private packages
----------------

Once you define your private packages in config file you need to enable them with command:

.. code-block:: bash
tutor distro enable-private-packages
Use your new packages
Expand All @@ -97,4 +98,4 @@ To use in local mode:
To use in dev mode:

1. Run ``tutor dev do init``
2. Run ``tutor dev start``
2. Run ``tutor dev start``
8 changes: 5 additions & 3 deletions docs/how_to_customize_distro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,10 @@ You can disable anyone by the ``tutor config save --set DISTRO_<PLUGIN_NAME>_DPK


.. code-block:: yml
DISTRO_<PLUGIN_NAME>_DPKG: None
If you want to override default packages or add a new one go to the corresponding section: `How to override or add a new package. <./how_to_add_new_packages.rst>`_
:warning: **NOTE**: From Olmo version Distro has not defaulted packages. Now it is necessary to add the packages you want in ``config.yml`` file.

If you want to override default packages or add a new one go to the corresponding section: `How to add a new package. <./how_to_add_new_packages.rst>`_

0 comments on commit 9689c0b

Please sign in to comment.