6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-15 17:47:13 +00:00

Add missing quotes in documentation

This commit is contained in:
Régis Behmo 2019-05-22 19:30:03 +02:00
parent f11f47f9f0
commit ea6c276b69
3 changed files with 12 additions and 12 deletions

View File

@ -208,7 +208,7 @@ Adding custom themes
Comprehensive theming is enabled by default, but only the default theme is compiled. To compile your own theme, add it to the ``env/build/openedx/themes/`` folder:: Comprehensive theming is enabled by default, but only the default theme is compiled. To compile your own theme, add it to the ``env/build/openedx/themes/`` folder::
git clone https://github.com/me/myopenedxtheme.git $(tutor config printroot)/env/build/openedx/themes/ git clone https://github.com/me/myopenedxtheme.git "$(tutor config printroot)/env/build/openedx/themes/"
The ``themes`` folder should have the following structure:: The ``themes`` folder should have the following structure::
@ -232,7 +232,7 @@ Installing extra xblocks and requirements
Would you like to include custom xblocks, or extra requirements to your Open edX platform? Additional requirements can be added to the ``env/build/openedx/requirements/private.txt`` file. For instance, to include the `polling xblock from Opencraft <https://github.com/open-craft/xblock-poll/>`_:: Would you like to include custom xblocks, or extra requirements to your Open edX platform? Additional requirements can be added to the ``env/build/openedx/requirements/private.txt`` file. For instance, to include the `polling xblock from Opencraft <https://github.com/open-craft/xblock-poll/>`_::
echo "git+https://github.com/open-craft/xblock-poll.git" >> $(tutor config printroot)/env/build/openedx/requirements/private.txt echo "git+https://github.com/open-craft/xblock-poll.git" >> "$(tutor config printroot)/env/build/openedx/requirements/private.txt"
Then, the ``openedx`` docker image must be rebuilt:: Then, the ``openedx`` docker image must be rebuilt::
@ -240,11 +240,11 @@ Then, the ``openedx`` docker image must be rebuilt::
To install xblocks from a private repository that requires authentication, you must first clone the repository inside the ``openedx/requirements`` folder on the host:: To install xblocks from a private repository that requires authentication, you must first clone the repository inside the ``openedx/requirements`` folder on the host::
git clone git@github.com:me/myprivaterepo.git ./openedx/requirements/myprivaterepo git clone git@github.com:me/myprivaterepo.git "$(tutor config printroot)/env/build/openedx/requirements/myprivaterepo"
Then, declare your extra requirements with the ``-e`` flag in ``openedx/requirements/private.txt``:: Then, declare your extra requirements with the ``-e`` flag in ``openedx/requirements/private.txt``::
echo "-e ./myprivaterepo" >> $(tutor config printroot)/env/build/openedx/requirements/private.txt echo "-e ./myprivaterepo" >> "$(tutor config printroot)/env/build/openedx/requirements/private.txt"
.. _edx_platform_fork: .. _edx_platform_fork:

View File

@ -80,7 +80,7 @@ Customised themes
With Tutor, it's pretty easy to develop your own themes. Start by placing your files inside the ``env/build/openedx/themes`` directory. For instance, you could start from the ``edx.org`` theme present inside the ``edx-platform`` repository:: With Tutor, it's pretty easy to develop your own themes. Start by placing your files inside the ``env/build/openedx/themes`` directory. For instance, you could start from the ``edx.org`` theme present inside the ``edx-platform`` repository::
cp -r /path/to/edx-platform/themes/edx.org $(tutor config printroot)/env/build/openedx/themes/ cp -r /path/to/edx-platform/themes/edx.org "$(tutor config printroot)/env/build/openedx/themes/"
Then, run a local webserver:: Then, run a local webserver::

View File

@ -133,14 +133,14 @@ In this example, the nginx container ports would be mapped to 81 and 444, instea
For nginx:: For nginx::
sudo ln -s $(tutor config printroot)/env/local/proxy/nginx/openedx.conf /etc/nginx/sites-enabled/ sudo ln -s "$(tutor config printroot)/env/local/proxy/nginx/openedx.conf" /etc/nginx/sites-enabled/
sudo systemctl reload nginx sudo systemctl reload nginx
For apache:: For apache::
sudo a2enmod proxy sudo a2enmod proxy
sudo a2enmod proxy_http sudo a2enmod proxy_http
sudo ln -s $(tutor config printroot)/env/local/proxy/apache2/openedx.conf /etc/apache2/sites-enabled/ sudo ln -s "$(tutor config printroot)/env/local/proxy/apache2/openedx.conf" /etc/apache2/sites-enabled/
sudo systemctl reload apache2 sudo systemctl reload apache2
If you have configured your platform to use SSL/TLS certificates for HTTPS access, the generation and renewal of certificates will not be managed by Tutor: you are supposed to take care of it yourself. Suggestions for generating and renewing these certificates with `Let's Encrypt <https://letsencrypt.org/>`_ are given by:: If you have configured your platform to use SSL/TLS certificates for HTTPS access, the generation and renewal of certificates will not be managed by Tutor: you are supposed to take care of it yourself. Suggestions for generating and renewing these certificates with `Let's Encrypt <https://letsencrypt.org/>`_ are given by::
@ -166,14 +166,14 @@ As an example, here is how to launch two different platforms, with nginx running
export TUTOR_ROOT=~/openedx/site1 export TUTOR_ROOT=~/openedx/site1
tutor config save --set WEB_PROXY=true --set LOCAL_PROJECT_NAME=tutor_site1 --set NGINX_HTTP_PORT=81 --set NGINX_HTTPS_PORT=481 tutor config save --set WEB_PROXY=true --set LOCAL_PROJECT_NAME=tutor_site1 --set NGINX_HTTP_PORT=81 --set NGINX_HTTPS_PORT=481
tutor local quickstart tutor local quickstart
sudo ln -s $(tutor config printroot)/env/local/proxy/nginx/openedx.conf /etc/nginx/sites-enabled/site1.conf sudo ln -s "$(tutor config printroot)/env/local/proxy/nginx/openedx.conf" /etc/nginx/sites-enabled/site1.conf
# platform 2 # platform 2
export TUTOR_ROOT=~/openedx/site2 export TUTOR_ROOT=~/openedx/site2
tutor config save --set WEB_PROXY=true --set LOCAL_PROJECT_NAME=tutor_site2 --set NGINX_HTTP_PORT=82 --set NGINX_HTTPS_PORT=482 tutor config save --set WEB_PROXY=true --set LOCAL_PROJECT_NAME=tutor_site2 --set NGINX_HTTP_PORT=82 --set NGINX_HTTPS_PORT=482
tutor local quickstart tutor local quickstart
sudo ln -s $(tutor config printroot)/env/local/proxy/nginx/openedx.conf /etc/nginx/sites-enabled/site2.conf sudo ln -s "$(tutor config printroot)/env/local/proxy/nginx/openedx.conf" /etc/nginx/sites-enabled/site2.conf
You should then have two different platforms, completely isolated from one another, running on the same server. You should then have two different platforms, completely isolated from one another, running on the same server.
@ -196,8 +196,8 @@ Versions 1 and 2 of Tutor were organized differently: they relied on many differ
Then, create the Tutor project root and move your data:: Then, create the Tutor project root and move your data::
mkdir -p $(tutor config printroot) mkdir -p "$(tutor config printroot)"
mv config.json data/ $(tutor config printroot) mv config.json data/ "$(tutor config printroot)"
`Download <https://github.com/regisb/tutor/releases>`_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path. `Download <https://github.com/regisb/tutor/releases>`_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path.
@ -217,7 +217,7 @@ With Tutor, all data are stored in a single folder. This means that it's extreme
3. Transfer the configuration, environment and platform data from server 1 to server 2:: 3. Transfer the configuration, environment and platform data from server 1 to server 2::
rsync -avr "$(tutor config printroot)"/ username@server2:/tmp/tutor/ rsync -avr "$(tutor config printroot)/" username@server2:/tmp/tutor/
4. On server 2, move the data to the right location:: 4. On server 2, move the data to the right location::