diff --git a/CHANGELOG.md b/CHANGELOG.md index 54a4a881ea5caf7b8a21af1db8efbe4a2110504d..a6ed5e5ab7c0fed55f7ff34226009972dad673c5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,7 +29,7 @@ - Move all gitlab API calls to GitBreaker library - SonarQube integration - Dependencies update -- **API**: Multi-process start is disabled where it is not in a production environment +- **API**: Multi-process start is disabled when it is not executed in a production environment ### 📚 Documentation - Migration from Wiki to static web site diff --git a/README.md b/README.md index 76adba7700bd0b39d581af2a2625e598589232e6..c1595e8c7753d7d4cd1a4eef18596c9bc71d7fa4 100644 --- a/README.md +++ b/README.md @@ -4,67 +4,4 @@ The dojo platform is an HES-SO that is an online tool built to help practice programming by allowing users to propose assignments and perform them as exercises. -The tool is very flexible and allows for proposing exercises for any language -and does not impose any limitation on a framework to be heavily relying -on Docker and Gitlab. These tools used in combination allow for automatic -correction of assignments in order to give immediate feedback to users -performing exercises. Solved exercises can then be shared among the community -of users such that they can inspire other users or give hints on ways to solve -a given exercise. - -The two major concepts of the platform are the **assignments** and the **exercises**. - -The principal way to interact with the Dojo platform is currently the `dojo` CLI. - -### The assignment -An assignment is written by a user that wants to propose an exercise. It is typically composed of a written description of the work to be performed, -and tests that must be passed once the exercise is successfully performed (and some configuration files for the infrastructure of the tests -such as docker files). At its core, an assignment is -nothing else than a git repository that can be forked in the form of an exercise and modified using standard git commands. - -In the future a dependency tree of assignments can be created, as well as tagging for filtering purposes. - -### The exercise -An exercise is an instance of an assignment which the learner will modify in order to make it pass the automatic tests. -It can be run locally on any user's machine using the dojo CLI. When the exercise is completed -it is pushed on the dojo where the CI/CD tools of Gitlab can evaluate it automatically and -notify the dojo platform of the result. The exercises can then be shared with other users -in order to propose a wide variety of solutions and can be a base for discussion among users -and with teachers. - - -## Main projects that are part of the Dojo platform -* [DojoBackendAPI](https://gitedu.hesge.ch/dojo_project/projects/backend/dojobackendapi): The API backend of the dojo platform -* [DojoExerciseChecker](https://gitedu.hesge.ch/dojo_project/projects/pipelines/dojoexercisechecker): The app (bundled in a Docker image) that check if an exercise have been solved correctly -* [DojoAssignmentChecker](https://gitedu.hesge.ch/dojo_project/projects/pipelines/dojoassignmentchecker): The app (bundled in a Docker image) that check if an assignment is valid -* [DojoCLI](https://gitedu.hesge.ch/dojo_project/projects/ui/dojocli): The command line interface to interact with the dojo platform -* [DojoWeb](https://gitedu.hesge.ch/dojo_project/projects/ui/dojoweb): The frontend of the dojo platform (coming soon) - - -## How to use Dojo ? -The principal way to interact with the Dojo platform is currently the `dojo` CLI. -You can find all the documentation in the [Wiki of the CLI project](https://gitedu.hesge.ch/dojo_project/projects/ui/dojocli/-/wikis/home). - - -## Support -* If you are a student that search help for a specific assignment, please contact your teaching staff. -* For any other questions, feature proposals or bug reports, please open an issue on the [Dojo Issues project](https://githepia.hesge.ch/dojo_project/issues/-/issues) on Gitlab and don't forget tags. - - -## Roadmap -You can find the roadmap (the deadlines are not available) of the project in the [Dojo Issues project](https://githepia.hesge.ch/dojo_project/issues/-/boards) on Gitlab. - - -## Contacts / Developers -* [Michaël Minelli](mailto:dojo@minelli.me): Main contact / developer -* [Orestis Malaspinas](mailto:orestis.malaspinas@hesge.ch): Project manager - - -## License -Most parts (e.g. all of the source code) of the project are licensed under the AGPLv3 license. - -Some parts (e.g. internal documentation) are private. - - -## Project status -The project is currently in test stage and is actively developed. +All informations are available on the [Dojo documentation website](https://www.hepiapp.ch/) : https://www.hepiapp.ch/.