htwkmooc/codecontender-doc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Embedded content creation section

Browse Source
This commit is contained in:
Christoph Walther
2024-09-20 10:54:07 +02:00
parent 4ccf99cef9
commit d1e1f9bd7c
3 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
content/content-creation.asciidoc
View File

@ -1,6 +1,6 @@
Once CodeOcean and Edly are setup, there are certain configuration steps to do, to provide an own course on this platform. The following steps show common steps used by content creators.
== Creating a course in openEdx ==
=== Creating a course in openEdx ===
A new course can be created on the edit page: `https://hostname/course-authoring`. Course creation needs a naming scheme for course, organization, course number and course run (for example "Python Introduction", "HTWK", "C123.1", "WiSe24").
@ -10,7 +10,7 @@ Before it is possible to link external LTI tools, this has to be enabled for thi
A single course consists out of a strict hierarchy of section, subsection and units. There is a "New Section" button in the top right of the course edit page. To create subsections and units, the structure level above must first be expanded using the caret symbol on the left. In the edit page for a single unit, an external grader can be linked using an "Advanced" module and the "LTI Consumer" entry.
== Creating a CodeOcean consumer for edX ==
=== Creating a CodeOcean consumer for edX ===
Go to Administation -> Integrations -> Consumer in CodeOcean and add a new entry to get individual secret and key for the LTI integration.
@ -25,7 +25,7 @@ These keys are required for OAuth 1 authentication, which is used by LTI 1.1. Th
The id can be chosen freely, but it has to be unique inside the edX platform.
== Linking a CodeOcean exercise ==
=== Linking a CodeOcean exercise ===
After adding the Lti passport with the required secrets of the Codeocean LTI provider, new exercises can be linked. To get the link, open up an exercise in CodeOcean (Administrator -> Exercises -> Exercises) by clicking on it's title. The LTI embedding parameters are shown like this: `locale=en&token=1234abcd`. We are only interested in the last part, the token.

2
content/dockerization-codeocean.asciidoc
View File

@ -1 +1 @@
One problem in the use of CodeOcean is the deployment. The installation instructions for CodeOcean are not comprehensive and only feature a development branch install, with a lot of installation steps to get the software working. They include Nomad as container orchestration instead of Kubernetes, which in itself doesn't run in Docker and therefore needs to be installed on the host system. Everything else, which is Codeocean with it's database and Poseidon, an interface between Codeocean and Nomad, was rewritten to run in Docker to simplify the deployment process. How this was done, and which configuration files are necessary is described in the following sections.
One problem in the use of CodeOcean is the deployment. The installation instructions for CodeOcean are not comprehensive and only feature a development branch install, with a lot of installation steps to get the software working. They include Nomad as container orchestration instead of Kubernetes, which in itself doesn't run in Docker and therefore needs to be installed on the host system. Everything else, which is Codeocean with it's database and Poseidon, an interface between Codeocean and Nomad, was rewritten to run in Docker to simplify the deployment process. How these containers are built and deployed is described in the following sections.

4
main.asciidoc
View File

@ -137,6 +137,10 @@ include::{includedir}/deployment.asciidoc[]
include::{includedir}/codeocean-dockerimages.asciidoc[]
== Content Creation and Linking ==
include::{includedir}/content-creation.asciidoc[]
== Sources ==
include::{includedir}/sources.asciidoc[]