From 9689c0b06f8be13968e0c2f05ab310169dc1925f Mon Sep 17 00:00:00 2001 From: Juan David Buitrago Date: Tue, 20 Jun 2023 09:26:58 -0500 Subject: [PATCH] docs: add information about removed default settings from distro --- README.md | 13 ++++++++++++- docs/how_to_add_new_packages.rst | 11 ++++++----- docs/how_to_customize_distro.rst | 8 +++++--- 3 files changed, 23 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 650861f..0409031 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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: @@ -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. @@ -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 @@ -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`. diff --git a/docs/how_to_add_new_packages.rst b/docs/how_to_add_new_packages.rst index 3cc633e..1d9c5b7 100644 --- a/docs/how_to_add_new_packages.rst +++ b/docs/how_to_add_new_packages.rst @@ -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: @@ -48,7 +48,7 @@ To override a default package identify its name and set it like ``DISTRO__DPK .. code-block:: yml - + DISTRO__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>`_ \ No newline at end of file + +: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>`_