Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about the Docker judge #479

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

Bond-009
Copy link
Contributor

@Bond-009 Bond-009 commented Dec 16, 2024

The documentation explains how to create exercises and some of the internal workings and limitations of the judge.

Copy link
Contributor

@jorg-vr jorg-vr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As our documentation doesn't have a fallback system for languages, the same pages and info will also have to be added in the dutch version.

I don't think it is required to translate though as this is pretty advanced stuff and English is fine for advanced users. We have solved this on other pages by adding a banner on top saying something like 'this page is not available in your language' and showing the untranslated version. (so duplicating the text)

@@ -0,0 +1,92 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bmesuere what's your opinion on adding these docs here?

For context, most judges except python and TESTed have their documentation in their respective github repo. With a link from our documentation.
Having it here will probably make it more discoverable, but might also create clutter for inexperienced users, as they probably won't need this more niche judge.
So I am a bit in doubt how best to proceed

## Docker
Docker is a judge that uses dodona-containerfile-evaluator, Hadolint, and Kaniko to evaluate Dockerfile exercises.
**Programming languages**: Dockerfile
**Get started** [Git repo](https://github.com/dodona-edu/judge-docker), [examples](https://github.com/Bond-009/dodona-docker-exercises) \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should probably also add a link to the documentation provided in this pr

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants