christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-10 15:20:56 +00:00
Code Issues Releases Activity

Change "openedx-docker" github urls to tutor

Browse Source
This commit is contained in:
Régis Behmo 2018-12-26 19:29:32 +01:00
parent bb5f10fc16
commit 8f7814cad3
4 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.rst
View File

@ -1,17 +1,17 @@
Tutor 🎓 Open edX 1-click install for everyone Tutor 🎓 Open edX 1-click install for everyone
============================================== ==============================================
.. image:: https://img.shields.io/travis/regisb/openedx-docker.svg .. image:: https://img.shields.io/travis/regisb/tutor.svg
:alt: Build status :alt: Build status
:target: https://travis-ci.org/regisb/openedx-docker :target: https://travis-ci.org/regisb/tutor
.. image:: https://img.shields.io/github/issues/regisb/openedx-docker.svg .. image:: https://img.shields.io/github/issues/regisb/tutor.svg
:alt: GitHub issues :alt: GitHub issues
:target: https://github.com/regisb/openedx-docker/issues :target: https://github.com/regisb/tutor/issues
.. image:: https://img.shields.io/github/issues-closed/regisb/openedx-docker.svg?colorB=brightgreen .. image:: https://img.shields.io/github/issues-closed/regisb/tutor.svg?colorB=brightgreen
:alt: GitHub closed issues :alt: GitHub closed issues
:target: https://github.com/regisb/openedx-docker/issues?q=is%3Aclosed :target: https://github.com/regisb/tutor/issues?q=is%3Aclosed
**Tutor** is a one-click install of `Open edX <https://openedx.org>`_, both for production and local development, inside docker containers. Tutor is easy to run, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world. **Tutor** is a one-click install of `Open edX <https://openedx.org>`_, both for production and local development, inside docker containers. Tutor is easy to run, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world.
@ -24,8 +24,8 @@ Quickstart
:: ::
git clone https://github.com/regisb/openedx-docker git clone https://github.com/regisb/tutor
cd openedx-docker/ cd tutor/
make local make local
Documentation Documentation
@ -36,4 +36,4 @@ Extensive documentation is available online: https://tutor.readthedocs.io/
How to contribute How to contribute
----------------- -----------------
We go to great lengths to make it as easy as possible for people to run Open edX inside Docker containers. If you have an improvement idea, feel free to `open an issue on Github <https://github.com/regisb/openedx-docker/issues/new>`_ so that we can discuss it. `Pull requests <https://github.com/regisb/openedx-docker/pulls>`_ will be happily examined, too! However, we should be careful to keep the project lean and simple: both to use and to modify. Optional features should not make the user experience more complex. Instead, documentation on how to add the feature is preferred. We go to great lengths to make it as easy as possible for people to run Open edX inside Docker containers. If you have an improvement idea, feel free to `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_ so that we can discuss it. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too! However, we should be careful to keep the project lean and simple: both to use and to modify. Optional features should not make the user experience more complex. Instead, documentation on how to add the feature is preferred.

16
docs/index.rst
View File

@ -6,17 +6,17 @@
Tutor 🎓 Open edX 1-click install for everyone Tutor 🎓 Open edX 1-click install for everyone
============================================== ==============================================
.. image:: https://img.shields.io/travis/regisb/openedx-docker.svg .. image:: https://img.shields.io/travis/regisb/tutor.svg
:alt: Build status :alt: Build status
:target: https://travis-ci.org/regisb/openedx-docker :target: https://travis-ci.org/regisb/tutor
.. image:: https://img.shields.io/github/issues/regisb/openedx-docker.svg .. image:: https://img.shields.io/github/issues/regisb/tutor.svg
:alt: GitHub issues :alt: GitHub issues
:target: https://github.com/regisb/openedx-docker/issues :target: https://github.com/regisb/tutor/issues
.. image:: https://img.shields.io/github/issues-closed/regisb/openedx-docker.svg?colorB=brightgreen .. image:: https://img.shields.io/github/issues-closed/regisb/tutor.svg?colorB=brightgreen
:alt: GitHub closed issues :alt: GitHub closed issues
:target: https://github.com/regisb/openedx-docker/issues?q=is%3Aclosed :target: https://github.com/regisb/tutor/issues?q=is%3Aclosed
**Tutor** is a one-click install of `Open edX <https://openedx.org>`_, both for production and local development, inside docker containers. Tutor is easy to run, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world. **Tutor** is a one-click install of `Open edX <https://openedx.org>`_, both for production and local development, inside docker containers. Tutor is easy to run, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world.
@ -56,9 +56,9 @@ In case of trouble, please follow the instructions in the :ref:`troubleshooting`
Contributing Contributing
------------ ------------
We go to great lengths to make it as easy as possible for people to run Open edX inside Docker containers. If you have an improvement idea, feel free to `open an issue on Github <https://github.com/regisb/openedx-docker/issues/new>`_ so that we can discuss it. `Pull requests <https://github.com/regisb/openedx-docker/pulls>`_ will be happily examined, too! However, we should be careful to keep the project lean and simple: both to use and to modify. Optional features should not make the user experience more complex. Instead, documentation on how to add the feature is preferred. We go to great lengths to make it as easy as possible for people to run Open edX inside Docker containers. If you have an improvement idea, feel free to `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_ so that we can discuss it. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too! However, we should be careful to keep the project lean and simple: both to use and to modify. Optional features should not make the user experience more complex. Instead, documentation on how to add the feature is preferred.
License License
------- -------
This work is licensed under the terms of the `MIT License <https://github.com/regisb/openedx-docker/blob/master/LICENSE.txt>`_. This work is licensed under the terms of the `MIT License <https://github.com/regisb/tutor/blob/master/LICENSE.txt>`_.

4
docs/quickstart.rst
View File

@ -5,8 +5,8 @@ Quickstart
:: ::
git clone https://github.com/regisb/openedx-docker git clone https://github.com/regisb/tutor
cd openedx-docker/ cd tutor/
make local make local
**That's it?** **That's it?**

8
docs/troubleshooting.rst
View File

@ -7,8 +7,8 @@ What should you do if you have a problem?
1. Read the error logs that appear in the console. When running a single server platform as daemon, you can view the logs with the ``docker-compose logs`` command. (see :ref:`logging` below) 1. Read the error logs that appear in the console. When running a single server platform as daemon, you can view the logs with the ``docker-compose logs`` command. (see :ref:`logging` below)
2. Check if your problem already has a solution right here in the :ref:`troubleshooting` section. 2. Check if your problem already has a solution right here in the :ref:`troubleshooting` section.
3. Search for your problem in the `open and closed Github issues <https://github.com/regisb/openedx-docker/issues?utf8=%E2%9C%93&q=is%3Aissue>`_. 3. Search for your problem in the `open and closed Github issues <https://github.com/regisb/tutor/issues?utf8=%E2%9C%93&q=is%3Aissue>`_.
4. If, despite all your efforts, you can't solve the problem, decide if the issue is related to Open edX or if it's specific to Tutor. In the latter case, you are most welcome to open an `issue on Github <https://github.com/regisb/openedx-docker/issues/new>`_. **Please follow the instructions from the issue template!!!** Your issue will be examined in all cases, but you can make my life much easier by giving me as much background information as possible. 4. If, despite all your efforts, you can't solve the problem, decide if the issue is related to Open edX or if it's specific to Tutor. In the latter case, you are most welcome to open an `issue on Github <https://github.com/regisb/tutor/issues/new>`_. **Please follow the instructions from the issue template!!!** Your issue will be examined in all cases, but you can make my life much easier by giving me as much background information as possible.
.. _logging: .. _logging:
@ -42,7 +42,7 @@ The containerized Nginx needs to listen to ports 80 and 443 on the host. If ther
However, you might now want to do that if you need a webserver for running non-Open edX related applications. In such cases... However, you might now want to do that if you need a webserver for running non-Open edX related applications. In such cases...
2. Run the nginx container on different ports: you can create a ``.env`` file in the ``openedx-docker`` directory in which you indicate different ports. For instance:: 2. Run the nginx container on different ports: you can create a ``.env`` file in the ``tutor`` directory in which you indicate different ports. For instance::
cat .env cat .env
NGINX_HTTP_PORT=81 NGINX_HTTP_PORT=81
@ -50,7 +50,7 @@ However, you might now want to do that if you need a webserver for running non-O
In this example, the nginx container ports would be mapped to 81 and 444, instead of 80 and 443. In this example, the nginx container ports would be mapped to 81 and 444, instead of 80 and 443.
You should note that with the latter solution, it is your responsibility to configure the webserver on the host as a proxy to the nginx container. See `this <https://github.com/regisb/openedx-docker/issues/69#issuecomment-425916825>`_ for http, and `this <https://github.com/regisb/openedx-docker/issues/90#issuecomment-437687294>`_ for https. You should note that with the latter solution, it is your responsibility to configure the webserver on the host as a proxy to the nginx container. See `this <https://github.com/regisb/tutor/issues/69#issuecomment-425916825>`_ for http, and `this <https://github.com/regisb/tutor/issues/90#issuecomment-437687294>`_ for https.
Help! The Docker containers are eating all my RAM/CPU/CHEESE Help! The Docker containers are eating all my RAM/CPU/CHEESE
------------------------------------------------------------ ------------------------------------------------------------