Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

Commit

Permalink
chore: Release v0.8.1 (#200)
Browse files Browse the repository at this point in the history
  • Loading branch information
jgwerner authored Jul 11, 2020
1 parent a958f57 commit 4cf07e3
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 7 deletions.
14 changes: 13 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# Changelog

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. For a more complete description of this project's features, [visit the IllumiDesk docs](https://docs.illumidesk.com).
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### 0.8.1 (2020-07-11)


### Features

* Add Java kernel ([#187](https://github.com/IllumiDesk/illumidesk/issues/187)) ([5800408](https://github.com/IllumiDesk/illumidesk/commit/5800408c1285a669f3ed95d53e4c12fc799d0800))
* Improve deployment times with ansible-playbook by updating setup-course base image ([#199](https://github.com/IllumiDesk/illumidesk/pull/199)) ([a958f57](https://github.com/IllumiDesk/illumidesk/commit/a958f578c9cfddda531590c0548e2927a2e52842))

### Bug Fixes

* Normalize course label for LTI 1.3 ([#198](https://github.com/IllumiDesk/illumidesk/issues/198)) ([4d5cffe](https://github.com/IllumiDesk/illumidesk/commit/4d5cffe4641b4b114ca8a944438d1ed52d248679))

## 0.8.0 (2020-07-08)

Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,18 +109,20 @@ By default, this setup uses the `FirstUseAuthenticator` and as such accepts any

* **JupyterHub**: Runs [JupyterHub](https://jupyterhub.readthedocs.org/en/latest/getting-started.html#overview) within a Docker container running as root.

* **Setup Course Image**: This image uses the built JupyterHub custom image as the base image (basically to avoid having to re install common dependencies). This image uses the [Quart](https://pgjones.gitlab.io/quart/) web server to communicate with the JupyterHub to scaffold host directories, launch shared grader notebooks as JupyterHub services, and updated configurations. This service is only applicable when using either LTI 1.1 or LTI 1.3 authenticators.
* **Setup Course Image**: Runs client services to communicate with the `JupyterHub REST API` to dynamically setup new courses. This service is only applicable when using either `LTI 1.1` or `LTI 1.3` authenticators.

* **Authenticator**: Authentication service. This setup relies on the [FirstUseAuthenticator](https://github.com/jupyterhub/firstuseauthenticator).
* **Authenticator**: The JupyterHub compatible authentication service. We recommend either using the `LTI11Authenticator` or `LTI13Authenticator` with your Learning Management System to take advantage of the latest features, however, the [FirstUseAuthenticator](https://github.com/jupyterhub/firstuseauthenticator) is available in case an LTI compatible LMS isn't available.
* **Spawner**: Spawning service to manage user notebooks. This setup uses classes which inherit from the [DockerSpawner](https://github.com/jupyterhub/dockerspawner) class.
* **Spawner**: Spawning service to manage user notebooks. This setup uses two classes which inherit from the [DockerSpawner](https://github.com/jupyterhub/dockerspawner) class: the `IllumiDeskRoleDockerSpawner` (to set the user's docker image based on LTI role) and the `IllumiDeskWorkSpaceDockerSpawner` (to set the user's docker image base on desired workspace type).
* **Data Directories**: This repo uses `docker-compose` to start all services and data volumes for JupyterHub, notebook directories, databases, and the `nbgrader exchange` directory using mounts from the host's file system.

* **Databases**: This setup relies on a standard `postgres` database running in its own container for the JupyterHub application and another separate and optional Postgres database for lab environments (useful to connect from user notebooks).

* **Network**: An external bridge network named `jupyter-network` is used by default. The grader service and the user notebooks are attached to this network.

* **Workspaces**: User servers are set and launched based on either the user's LTI compatible role (student or instructor) or by workspace type (Jupyter Classic, Jupyter Lab, THEIA IDE, RStudio, or VS Code).
## Customization
You may customize your setup by customizing additional variables in the `hosts` file. For example, you can run the `make deploy` command to set your own organization name and top level domain when using this setup behind a reverse-proxy with TLS termination.
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "illumidesk",
"version": "0.8.0",
"version": "0.8.1",
"description": "Teach and learning with web-based notebooks!",
"scripts": {
"release": "standard-version"
Expand Down
2 changes: 1 addition & 1 deletion src/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
version_info = (
0,
8,
0,
1,
)
__version__ = ".".join(map(str, version_info[:3]))

Expand Down

0 comments on commit 4cf07e3

Please sign in to comment.