added edX documentation

This commit is contained in:
Elmar Kresse
2024-07-22 14:59:03 +02:00
parent 6aaa02afff
commit d56772616f
5 changed files with 224 additions and 5 deletions

View File

@ -1,9 +1,16 @@
# CodeContender
:author: Christoph Walther, Elmar Kresse
:toc: left
:toc-title: Table of Contents
:sectnums:
:toclevels: 2
:data-uri:
ifndef::imagesdir[:imagesdir: ./media]
= CodeContender
CodeContender is a platform for learning and practicing coding. It is a web application that provides a set of coding courses with diffrend tasks and questions. Content is divided into different categories and levels. Users get information in form of text, images, and videos. They can also practice coding in an online code editor. The platform is designed to be user-friendly and easy to use. It is suitable for beginners as well as advanced users.
Goal after finishing a course is to pass a final test and get a certificate.
## Problem Analysis
== Problem Analysis
Software Setup:
* is a cluster already running wtih the required software? (e.g. docker, kubernetes, etc.)
@ -13,7 +20,7 @@ Software Setup:
* Configuration files for the cluster
### Requirements
=== Requirements
* Authentication, Authorization, User Management
@ -61,7 +68,7 @@ Software Setup:
## Architecture
image::media/codeContender.png[]
image::codeContender.png[]
### Components
@ -102,3 +109,12 @@ Repositorys need to be secured and limited in size. That users can't upload larg
## Existing Solutions
include::content/existing_solutions.asciidoc[]
## edX Platform
include::content/edx.asciidoc[]
### edX Kubernetes Deployment
include::content/edx-k8s.asciidoc[]