diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 0dd42bc..4a02ebb 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,9 +1,8 @@ stages: - build - - deploy:docs # TODO move this to the end - deploy:images - deploy:pypi - + - deploy:docs build:images: script: diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f72a8f..2626ea6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -165,7 +165,7 @@ Note: Breaking changes between versions are indicated by "💥". - 2019-01-04 [Bugfix] Fix xqueue consumer command - 2018-12-26 [Improvement] Upgrade nodejs to 5.5.1 - 2018-12-07 [Improvement] Bundle theme and production static assets in the openedx docker image -- 2018-12-02 [Feature] Download extra locales from [openedx-i18n](https://github.com/regisb/openedx-i18n/) to the Open edX Docker image +- 2018-12-02 [Feature] Download extra locales from [openedx-i18n](https://github.com/openedx/openedx-i18n/) to the Open edX Docker image - 2018-11-28 [Feature] Easily change openedx docker image - 2018-11-28 [Feature] Enable comprehensive theming! - 2018-11-28 [Improvement] Get rid of datadog diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index daca96d..d57bc4b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,6 +1,6 @@ Contribution Guidelines ======================= -You are most warmly welcome to make contributions and open pull requests on the Tutor repository! Would you like to develop a new feature? You can discuss it first on the `Tutor discussion forums `_, although this is not mandatory. Are you trying to fix an existing issue? Please first `create a new issue `_, where we can discuss the problem and possible solutions. +You are most warmly welcome to make contributions and open pull requests on the Tutor repository! Would you like to develop a new feature? You can discuss it first on the `Tutor discussion forums `_, although this is not mandatory. Are you trying to fix an existing issue? Please first `create a new issue `_, where we can discuss the problem and possible solutions. Happy hacking! ☘️ \ No newline at end of file diff --git a/Makefile b/Makefile index 60f293e..67525a8 100644 --- a/Makefile +++ b/Makefile @@ -88,13 +88,13 @@ ci-github: ./releases/github-release ## Upload assets to github sed "s/TUTOR_VERSION/v$(shell make version)/g" docs/_release_description.md > releases/description.md git log -1 --pretty=format:%b >> releases/description.md ./releases/github-release release \ - --user regisb \ + --user overhangio \ --repo tutor \ --tag "v$(shell make version)" \ --name "v$(shell make version)" \ --description "$$(cat releases/description.md)" || true ./releases/github-release upload \ - --user regisb \ + --user overhangio \ --repo tutor \ --tag "v$(shell make version)" \ --name "tutor-$$(uname -s)_$$(uname -m)" \ diff --git a/README.rst b/README.rst index 3308bdf..71d2f73 100644 --- a/README.rst +++ b/README.rst @@ -3,23 +3,23 @@ Tutor 🎓 The docker-based Open edX distribution designed for peace of mind ========================================================================== -.. image:: https://img.shields.io/travis/regisb/tutor.svg +.. image:: https://img.shields.io/travis/overhangio/tutor.svg :alt: Build status - :target: https://travis-ci.org/regisb/tutor + :target: https://travis-ci.org/overhangio/tutor .. image:: https://img.shields.io/badge/docs-current-brightgreen.svg :alt: Documentation :target: https://docs.tutor.overhang.io -.. image:: https://img.shields.io/github/issues/regisb/tutor.svg +.. image:: https://img.shields.io/github/issues/overhangio/tutor.svg :alt: GitHub issues - :target: https://github.com/regisb/tutor/issues + :target: https://github.com/overhangio/tutor/issues -.. image:: https://img.shields.io/github/issues-closed/regisb/tutor.svg?colorB=brightgreen +.. image:: https://img.shields.io/github/issues-closed/overhangio/tutor.svg?colorB=brightgreen :alt: GitHub closed issues - :target: https://github.com/regisb/tutor/issues?q=is%3Aclosed + :target: https://github.com/overhangio/tutor/issues?q=is%3Aclosed -.. image:: https://img.shields.io/github/license/regisb/tutor.svg +.. image:: https://img.shields.io/github/license/overhangio/tutor.svg :alt: AGPL License :target: https://www.gnu.org/licenses/agpl-3.0.en.html @@ -34,7 +34,7 @@ Tutor 🎓 The docker-based Open edX distribution designed for peace of mind Quickstart ---------- -1. Install the `latest stable release `_ of Tutor +1. Install the `latest stable release `_ of Tutor 2. Run ``tutor local quickstart`` 3. You're done! @@ -66,6 +66,6 @@ Tutor was presented at the 2019 Open edX conference in San Diego, CA. Here's the Contributing ------------ -We are very much open to new ideas and features for Tutor. If you have an improvement idea, feel free to first discuss it on the `Tutor forums `_. If you are not quite familiar with Open edX or if you need technical advice, the forums are a great place to start, too. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an upstream issue with Open edX. Then, `open an issue on Github `_. `Pull requests `_ will be happily examined, too! +We are very much open to new ideas and features for Tutor. If you have an improvement idea, feel free to first discuss it on the `Tutor forums `_. If you are not quite familiar with Open edX or if you need technical advice, the forums are a great place to start, too. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an upstream issue with Open edX. Then, `open an issue on Github `_. `Pull requests `_ will be happily examined, too! .. _readme_contributing_end: \ No newline at end of file diff --git a/cloud/aws.sh b/cloud/aws.sh index 0d1828a..2022186 100755 --- a/cloud/aws.sh +++ b/cloud/aws.sh @@ -1,6 +1,6 @@ #! /bin/bash -e # Provision an AWS cloud instance with tutor. -# Run with: curl -sSL https://raw.githubusercontent.com/regisb/tutor/master/cloud/aws.sh | bash -e +# Run with: curl -sSL https://raw.githubusercontent.com/overhangio/tutor/master/cloud/aws.sh | bash -e export DEBIAN_FRONTEND=noninteractive @@ -32,8 +32,8 @@ sudo curl -L "https://github.com/docker/compose/releases/download/1.23.2/docker- sudo chmod +x /usr/local/bin/docker-compose echo "=============== Installing tutor" -export TUTOR_VERSION="$(curl -sSL https://api.github.com/repos/regisb/tutor/releases/latest | grep tag_name | sed "s/.*tag_name\": \"\(.*\)\",/\1/g")" -sudo curl -L "https://github.com/regisb/tutor/releases/download/$TUTOR_VERSION/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor +export TUTOR_VERSION="$(curl -sSL https://api.github.com/repos/overhangio/tutor/releases/latest | grep tag_name | sed "s/.*tag_name\": \"\(.*\)\",/\1/g")" +sudo curl -L "https://github.com/overhangio/tutor/releases/download/$TUTOR_VERSION/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor sudo chmod +x /usr/local/bin/tutor echo "=============== Pulling vendor docker images" diff --git a/docs/_release_description.md b/docs/_release_description.md index 860e66b..8d12c7a 100644 --- a/docs/_release_description.md +++ b/docs/_release_description.md @@ -1,6 +1,6 @@ Tutor can be installed simply by downloading the compiled binaries: - sudo curl -L "https://github.com/regisb/tutor/releases/download/TUTOR_VERSION/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor + sudo curl -L "https://github.com/overhangio/tutor/releases/download/TUTOR_VERSION/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor sudo chmod +x /usr/local/bin/tutor See the [install docs](https://docs.tutor.overhang.io/install.html) for more install options and instructions. diff --git a/docs/cli_download.rst b/docs/cli_download.rst index 4e2ecb6..2cbabf2 100644 --- a/docs/cli_download.rst +++ b/docs/cli_download.rst @@ -2,5 +2,5 @@ .. parsed-literal:: - sudo curl -L "\ https\ ://github.com/regisb/tutor/releases/download/v\ |tutor_version|/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor + sudo curl -L "\ https\ ://github.com/overhangio/tutor/releases/download/v\ |tutor_version|/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor sudo chmod +x /usr/local/bin/tutor diff --git a/docs/faq.rst b/docs/faq.rst index 929a02e..1cd12fa 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -49,7 +49,7 @@ Those features are currently not available in Tutor: - `ecommerce `_ - `analytics `_ -Those extra services were considered low priority while developing this project, but we are planning on adding them to Tutor, eventually. If you need one or more of these services, feel free to let me know by opening a `Github issue `_. In particular, support for the Analytics stack is going to require a lot of work and I am looking forward to financial sponsorship. Please get in touch if you're interested. +Those extra services were considered low priority while developing this project, but we are planning on adding them to Tutor, eventually. If you need one or more of these services, feel free to let me know by opening a `Github issue `_. In particular, support for the Analytics stack is going to require a lot of work and I am looking forward to financial sponsorship. Please get in touch if you're interested. Are there people already running this in production? ---------------------------------------------------- @@ -59,8 +59,9 @@ Yes, many of them. There is no way to count precisely how many running Open edX Why should I trust software written by some random guy on the Internet? ----------------------------------------------------------------------- -You shouldn't :) I'm `Régis Behmo `_ and I have been working on Tutor since early 2018. I have been a contributor of the Open edX project since 2015. In particular, I have worked for 2 years on `FUN-MOOC `_, one of the top 5 largest Open edX platforms in the world. Here are the talks I have presented at the Open edX conferences: +You shouldn't :) Tutor is actively maintained by `Overhang.io `_, a France-based company founded by `Régis Behmo `_. Régis has been working on Tutor since early 2018; he has been a contributor of the Open edX project since 2015. In particular, I have worked for 2 years on `FUN-MOOC `_, one of the top 5 largest Open edX platforms in the world. He presented several talks at the Open edX conferences: +- *Deploying a robust, scalable Open edX platform in 1 click (or less) with Tutor*, March 2019 (`video `_, `slides `_) - *Videofront: a Self-Hosted YouTube*, June 2017 (`video `__, `slides `__) - *Open edX 101: A Source Code Review*, June 2016 (`video `__, `slides `__) - *FUN: Life in the Avant-Garde*, Oct. 2015 (`video `__, `slides `__) diff --git a/docs/index.rst b/docs/index.rst index 02de721..9906f7c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,7 +31,7 @@ Source code ----------- -The complete source code for Tutor is available on Github: https://github.com/regisb/tutor +The complete source code for Tutor is available on Github: https://github.com/overhangio/tutor .. include:: ../README.rst :start-after: _readme_support_start: @@ -44,7 +44,7 @@ The complete source code for Tutor is available on Github: https://github.com/re License ------- -This work is licensed under the terms of the `GNU Affero General Public License (AGPL) `_. +This work is licensed under the terms of the `GNU Affero General Public License (AGPL) `_. The AGPL license covers the Tutor code, including the Dockerfiles, but not the content of the Docker images which can be downloaded from https://hub.docker.com. Software other than Tutor provided with the docker images retain their original license. diff --git a/docs/install.rst b/docs/install.rst index b73cd47..0e3ed2d 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -26,7 +26,7 @@ Also, the host running the containers should be a 64 bit platform. (images are n Direct binary downloads ----------------------- -The latest binaries can be downloaded from https://github.com/regisb/tutor/releases. From the command line: +The latest binaries can be downloaded from https://github.com/overhangio/tutor/releases. From the command line: .. include:: cli_download.rst @@ -40,7 +40,7 @@ Tutor can be launched on Amazon Web Services very quickly with the `official Tut Installing from source ---------------------- -If you would like to inspect the Tutor source code, you are most welcome to install Tutor from `Pypi `_ or directly from `the Github repository `_. You will need python >= 3.5 and the libyaml development headers. On Ubuntu, these requirements can be installed by running:: +If you would like to inspect the Tutor source code, you are most welcome to install Tutor from `Pypi `_ or directly from `the Github repository `_. You will need python >= 3.5 and the libyaml development headers. On Ubuntu, these requirements can be installed by running:: sudo apt install python3 libyaml-dev @@ -50,7 +50,7 @@ Installing from pypi:: Installing from a local clone of the repository:: - git clone https://github.com/regisb/tutor + git clone https://github.com/overhangio/tutor cd tutor pip install -e . diff --git a/docs/local.rst b/docs/local.rst index 07dc59b..74f9ec7 100644 --- a/docs/local.rst +++ b/docs/local.rst @@ -216,7 +216,7 @@ Then, create the Tutor project root and move your data:: mkdir -p "$(tutor config printroot)" mv config.json data/ "$(tutor config printroot)" -`Download `_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path. +`Download `_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path. Finally, start your platform again:: diff --git a/docs/plugins.rst b/docs/plugins.rst index 9ee2004..bb2c9b5 100644 --- a/docs/plugins.rst +++ b/docs/plugins.rst @@ -123,4 +123,4 @@ MinIO tutor plugins enable minio -See the `plugin documentation `_. \ No newline at end of file +See the `plugin documentation `_. \ No newline at end of file diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 752c174..73e99b9 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -3,7 +3,7 @@ Quickstart (1-click install) ============================ -1. `Download `_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path. From the command line: +1. `Download `_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path. From the command line: .. include:: cli_download.rst diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 739be2a..4ee8ad8 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -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) 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 `_. -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 `_. **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. +3. Search for your problem in the `open and closed Github issues `_. +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 `_. **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: diff --git a/docs/tutor.rst b/docs/tutor.rst index 726dc2f..3ab9d1f 100644 --- a/docs/tutor.rst +++ b/docs/tutor.rst @@ -5,7 +5,7 @@ Tutor development Start by cloning the Tutor repository:: - git clone https://github.com/regisb/tutor.git + git clone https://github.com/overhangio/tutor.git cd tutor/ Install requirements diff --git a/plugins/minio/README.rst b/plugins/minio/README.rst index e1e11c3..e754392 100644 --- a/plugins/minio/README.rst +++ b/plugins/minio/README.rst @@ -8,9 +8,9 @@ In particular, this plugin is essential for `Kubernetes deployment `_. If you have installed Tutor from source, you will have to install this plugin from source, too:: +The plugin is currently bundled with the `binary releases of Tutor `_. If you have installed Tutor from source, you will have to install this plugin from source, too:: - git clone https://github.com/regisb/tutor/ + git clone https://github.com/overhangio/tutor/ pip install -e tutor/plugins/minio Then, to enable this plugin, run:: diff --git a/plugins/minio/setup.py b/plugins/minio/setup.py index a3a4f4b..d37cfd0 100644 --- a/plugins/minio/setup.py +++ b/plugins/minio/setup.py @@ -14,8 +14,8 @@ setup( url="https://docs.tutor.overhang.io/", project_urls={ "Documentation": "https://docs.tutor.overhang.io/", - "Code": "https://github.com/regisb/tutor/tree/master/plugins/minio", - "Issue tracker": "https://github.com/regisb/tutor/issues", + "Code": "https://github.com/overhangio/tutor/tree/master/plugins/minio", + "Issue tracker": "https://github.com/overhangio/tutor/issues", "Community": "https://discuss.overhang.io", }, license="AGPLv3", diff --git a/setup.py b/setup.py index 1ab9112..72d34a2 100644 --- a/setup.py +++ b/setup.py @@ -17,8 +17,8 @@ setup( url="https://docs.tutor.overhang.io/", project_urls={ "Documentation": "https://docs.tutor.overhang.io/", - "Code": "https://github.com/regisb/tutor", - "Issue tracker": "https://github.com/regisb/tutor/issues", + "Code": "https://github.com/overhangio/tutor", + "Issue tracker": "https://github.com/overhangio/tutor/issues", "Community": "https://discuss.overhang.io", }, license="AGPLv3", diff --git a/tutor/templates/build/openedx/Dockerfile b/tutor/templates/build/openedx/Dockerfile index 305a9ea..a62257e 100644 --- a/tutor/templates/build/openedx/Dockerfile +++ b/tutor/templates/build/openedx/Dockerfile @@ -27,7 +27,7 @@ WORKDIR /openedx/edx-platform # Download extra locales to /openedx/locale # TODO upgrade this to ironwood RUN cd /tmp \ - && curl -L -o openedx-i18n.tar.gz https://github.com/regisb/openedx-i18n/archive/hawthorn.tar.gz \ + && curl -L -o openedx-i18n.tar.gz https://github.com/openedx/openedx-i18n/archive/hawthorn.tar.gz \ && tar xzf /tmp/openedx-i18n.tar.gz \ && mv openedx-i18n-hawthorn/edx-platform/locale/ /openedx/locale/ \ && rm -rf openedx-i18n* @@ -43,7 +43,7 @@ RUN pip install -r requirements/edx/development.txt # Install patched version of ora2 RUN pip uninstall -y ora2 && \ - pip install git+https://github.com/regisb/edx-ora2.git@2.2.0-patched#egg=ora2==2.2.0 + pip install git+https://github.com/overhangio/edx-ora2.git@2.2.0-patched#egg=ora2==2.2.0 # Install a recent version of nodejs RUN nodeenv /openedx/nodeenv --node=8.9.3 --prebuilt