updated paths for README

This commit is contained in:
Elmar Kresse
2024-07-22 15:45:41 +02:00
parent d2a000361b
commit e358823170
2 changed files with 10 additions and 14 deletions

View File

@ -1,5 +1,5 @@
ifndef::imagesdir[:imagesdir: ../media]
=== Allgemeine Informationen zur Open-Source-Lernplattform edX
=== Allgemeine Informationen zur Open-Source-Lernplattform edX ===
**Gründung und Geschichte:**
edX wurde im Jahr 2012 von der Harvard University und dem Massachusetts Institute of Technology (MIT) angfangen zu entwickeln. Die Plattform wird im Rahmen einer Non-Profit-Organisation geleitet, um hochwertige Bildung für alle zugänglich zu machen und eine Gemeinschaft von Lernenden und Lehrenden weltweit zu schaffen. Seit ihrer Gründung hat sich edX zu einer der größten Plattformen für Online-Lernen entwickelt, die Kurse von Universitäten und Institutionen weltweit anbietet.

View File

@ -5,12 +5,12 @@
:toclevels: 2
:data-uri:
ifndef::imagesdir[:imagesdir: ./media]
= CodeContender
= 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.)
@ -20,7 +20,7 @@ Software Setup:
* Configuration files for the cluster
=== Requirements
=== Requirements ===
* Authentication, Authorization, User Management
@ -63,9 +63,6 @@ Software Setup:
** Code Testing
** Code Sharing
## Architecture
image::codeContender.png[]
@ -106,15 +103,14 @@ The repository makes it possible to work in your own environment and push the ch
Repositorys need to be secured and limited in size. That users can't upload large files or malicious content. The repository should be monitored and checked for changes. It should be possible to revert changes and restore the repository to a previous state.
## Existing Solutions
== Existing Solutions ==
include::./content/existing_solutions.asciidoc[]
include::content/existing_solutions.asciidoc[]
== edX Platform ==
## edX Platform
include::content/edx.asciidoc[]
include::./content/edx.asciidoc[]
=== edX Kubernetes Deployment ===
### edX Kubernetes Deployment
include::./content/edx-k8s.asciidoc[]
include::content/edx-k8s.asciidoc[]