6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-12 22:27:47 +00:00
Commit Graph

53 Commits

Author SHA1 Message Date
Carlos Muniz
fe901ab9de feat: deprecate "quickstart" and rename to "launch"
`quickstart` is being renamed to `launch` and deprecated in favor of
using `launch`. The `quickstart` function temporarily aliases to
`launch`. Further mentions of `quickstart` have been changed to
reference `launch` instead.

We are indicating that this change is breaking 💥 to encourage people to
migrate their scripts right away!
2022-09-30 12:05:35 +02:00
Régis Behmo
4b015bdc4e docs: move forum to discuss.openedx.org
Now that Tutor is the official community installation for Open edX, it no
longer makes sense to host a forum that is separate from the general Open edX
forum. Moving conversations there will encourage cross-communication between
projects and maintainers. This change is part of a larger overhaul described in
this Tutor enhancement proposal (TEP):
https://discuss.overhang.io/t/tep-rethinking-the-tutor-maintainers-program/2724

In the future, plugin maintainers should point their users to the Open edX
forum as well. They are encouraged to create dedicated "tutor-pluginnname" tags
on the forum and to set their notification level to "watching".
2022-05-23 09:48:19 +02:00
AmiT
f03f0ef77b docs: fix plugins broken link 2022-05-19 09:49:25 +02:00
Emad Rad
a25ae73031 minor typos fixed 2022-03-29 08:44:33 +02:00
Régis Behmo
26ed1d77de docs: minor formatting/link improvements 2022-01-18 09:25:35 +01:00
Derek Crosson
4488f27603 chore: update android app repository url 2022-01-03 06:46:04 +01:00
Régis Behmo
3f4c1263e6 docs: shields that are actually useful
It is unnecessary to point to CI, or to indicate the doc version. Instead, we
link directly to the source code. Also, we improve the icon colors and general
appearance.
2021-10-14 12:59:57 +02:00
Régis Behmo
b6aefdab7d docs: advertise Cairn and the maintainers group
Here we add to the docs a few shameless plugs about Cairn -- because
it's really awesome!
We also add a few improvements to the wording, here and there.
2021-07-03 11:07:37 +02:00
Régis Behmo
ceddc11c29 feat: upgrade to open-release/lilac.master
One of the breaking changes of this release is the removal of the webui and
android features; these are moved to dedicated plugins. This causes a breaking
change: the renaming of the DOCKER_IMAGE_ANDROID
config variable to ANDROID_DOCKER_IMAGE.

See this TEP for reference: https://discuss.overhang.io/t/separate-webui-and-android-from-tutor-core-and-move-to-dedicated-plugins/1473
2021-06-08 23:29:12 +02:00
Régis Behmo
6af6390fb1 refactor: migrate from Travis.ci to GitHub Actions
GitHub Actions now performs the following tasks:

- run tests on every PR
- sync with git.overhang.io on push
- build binary releases on tags

Travis.CI was completely removed from this repo.
2021-05-17 21:29:52 +02:00
Régis Behmo
a17c8dab24 Update "contributing" section of the readme 2020-12-13 00:43:55 +01:00
Régis Behmo
728ef966dc v11.0.0 (2020-12-09)
- 💥[Improvement] Upgrade Open edX to Koa
- 💥 Setting changes:
    - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``.
    - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``.
    - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added.
    - The ``NGINX_HTTPS_PORT`` setting is deprecated.
- Architectural changes:
    - Use Caddy as a web proxy for automated SSL/TLS certificate generation:
	- Nginx no longer listens to port 443 for https traffic
	- The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management.
	- Configuration files for web proxies are no longer provided.
	- Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager.
    - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container.
    - Replace memcached and rabbitmq by redis.
- Additional features:
    - Make it possible to disable all plugins at once with ``plugins disable all``.
    - Add ``tutor k8s wait`` command to wait for a pod to become ready
    - Faster, more reliable static assets with local memory caching
- Deprecation: proxy files for Apache and Nginx are no longer provided out of the box.
- Removed plugin `{{ patch (...) }}` statements:
    - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch.
    - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-12-10 01:05:02 +01:00
Régis Behmo
545e9af2dd Thanks America for not fucking up this one 2020-11-19 11:32:17 +01:00
Régis Behmo
7b7f548dbd Switch "do not fuck this up" message to section
Admonitions are not supported by Github's rst parser.
2020-10-02 12:16:58 +02:00
Régis Behmo
026e0d6c89 Hey America! Please do not fuck this up. 2020-10-02 12:02:20 +02:00
Régis Behmo
49c71f8af2 Add scorm xblock to the openedx docker image 2020-04-25 14:20:13 +02:00
Régis Behmo
fffc90442e Add youtube videos to docs
This is possible thanks to a custom youtube tag. See
https://jasonstitt.com/youtube-in-restructured-text
2020-02-25 17:02:39 +01:00
Régis Behmo
a2f50205fa Fix image link in docs 2020-02-25 17:01:44 +01:00
Régis Behmo
4078c380db Add more links to tutor lts 2020-01-10 15:46:56 +01:00
Régis Behmo
e8115138ae Add link to tutor lts 2020-01-10 15:29:56 +01:00
Régis Behmo
2f882216e0 Fix tutor logo link in docs 2020-01-10 15:23:05 +01:00
Régis Behmo
7ac3e8f9b1 Docs: remove unreachable pipeline shield image
Pipeline shield image is accessible only to logged-in users.
2019-12-05 14:24:04 +01:00
Régis Behmo
30df00bdf1 Fix readme typo 2019-10-24 20:28:20 +02:00
Régis Behmo
d1f7d02470 Improve docs
- Add tutor logo
- add "edit on github" links
- modify theme colors
- and various other things...
2019-10-17 17:21:35 +02:00
Régis Behmo
b04b9e19c1 docs: include user testimonials 2019-10-08 22:25:20 +02:00
Régis Behmo
2b8c0778b2 Fix readme compilation 2019-10-07 14:40:49 +02:00
Régis Behmo
5e6ad893a6 Coolify readme 2019-10-07 14:26:17 +02:00
Régis Behmo
53f1813409 Readme typo 2019-09-23 12:19:12 +02:00
Régis Behmo
9fd7980625 Add gitlab CI badge to readme 2019-06-24 13:06:40 +02:00
Régis Behmo
de5b82fd63 Migrate github repo to overhangio organization 2019-06-23 23:11:07 +02:00
Régis Behmo
68382c440c Do not embed video in README
"raw" directive is not supported bny pypi in README.
2019-06-17 22:56:24 +02:00
Régis Behmo
307398a306 Add link to youtube video in README
Github does not support embedded videos in README, so we need to
directly link to the video on youtube.
2019-05-29 10:31:53 +02:00
Régis Behmo
04893981b7 Add github template for questions 2019-05-23 12:59:18 +02:00
Régis Behmo
4e98b020db Include lighting talk video in docs 2019-05-20 18:38:43 +02:00
Régis Behmo
b4e3c43902 Better documentation
- More concise table of contents
- New intro
- Simpler make commands
- Fix a couple typos here and there
- Get rid of the default github issue template, and start using the
template created online.
2019-05-13 16:34:17 +02:00
Régis Behmo
e25982ed20 Improve docs wording and de-duplicate from readme
The sphinx `include` directive is great!
2019-04-25 09:36:18 +02:00
Régis Behmo
1a94b05188 Better release descriptions
By using `github-releases`, we can now generate much better release
description blurbs.
2019-04-22 15:15:47 +02:00
Régis Behmo
847678bb07 Get rid of the "latest" release tag
The "latest" tag is a pain to maintain: it's a tag that we delete and
re-create at every release. Whenever we delete it, the binaries become
unavailable on Github until they are re-generated. Thus, from now on, we
conform to good practices (as examplified by the
github.com/docker/compose) project and distribute only pinned release.

The "nightly" tag remains, for now, as it allows us to distribute beta
features. It may disappear in the future.
2019-04-22 13:36:40 +02:00
Régis Behmo
6a5527458f Docs are now hosted with https 2019-02-20 13:53:22 +01:00
Régis Behmo
e7f82b5465 Fix http link to docs 2019-02-19 22:39:04 +01:00
Régis Behmo
aa53524f70 Add documentation status badge 2019-02-19 22:37:59 +01:00
Régis Behmo
45703b73b6 Add links to tutor forums 2019-02-19 22:26:43 +01:00
Régis Behmo
b05eed92d5 Update installation instructions 2019-02-18 09:53:54 +01:00
Régis Behmo
1781e6e3c3 Gif animation for quickstart
Animation created with Terminalizer: https://terminalizer.com/
Try it! It's awesome :)
2019-02-10 19:29:37 +01:00
Régis Behmo
4331bc5712 Tutor v3 complete rewrite
Replace all make commands by a single "tutor" binary. Environment and
data are all moved to ~/.tutor/local/share/tutor. We take the
opportunity to add a web UI and revamp the documentation.

This is a complete rewrite.

Close #121.
Close #147.
2019-02-09 20:30:01 +01:00
Régis Behmo
e864e94bb5
Fix docs link (ssl not supported, yet) 2018-12-28 16:52:33 +01:00
Régis Behmo
91be239ca1 Update asciinema link 2018-12-27 02:49:12 +01:00
Régis Behmo
13d1baa6b6 Fix quickstart instructions 2018-12-27 01:28:40 +01:00
Régis Behmo
5937d757fb In quickstart, suggest "make all" and not "local" 2018-12-27 01:17:12 +01:00
Régis Behmo
0c6372d0ff Change tutor docs url to overhang.io domain 2018-12-26 19:32:36 +01:00