docs: improve README #56
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mariajgrimaldi
requested changes
Jun 6, 2024
Co-authored-by: Maria Grimaldi <[email protected]>
Co-authored-by: Maria Grimaldi <[email protected]>
dcoa
force-pushed
the
dcoa/readme-improvement
branch
from
726d6df
to
5c6f9a8
Compare
MoisesGSalas
reviewed
Jun 6, 2024
README.rst
Outdated
|
|
||
| .. code-block:: bash | ||
|
|
||
| tutor plugins enable codejail | ||
|
|
||
| Then, you will have to install the "docker-edx-sandbox" apparmor profile on your host: | ||
| Install the "docker-edx-sandbox" AppArmor profile on your host: |
There was a problem hiding this comment.
Suggested change
| Install the "docker-edx-sandbox" AppArmor profile on your host: | |
| Run the initialization jobs to install the required AppArmor profile on your host: |
The name of the profile changes depending on the python version used by the sandbox (e.g docker-edx-sandbox-3.8.6).
Can we also add a note that the profile must be loaded again if the host is rebooted?
README.rst
Outdated
| CODEJAIL_EXTRA_PIP_REQUIREMENTS: | ||
| - pybryt | ||
|
|
||
| **NOTE:** For some configurations to work, the codejail image must be rebuilt. Command to rebuild codejail: ``tutor images build codejail``. |
There was a problem hiding this comment.
Do we know which configurations merit a new build? Can we add them here?
There was a problem hiding this comment.
I think most people don't build this image, so it should rather be framed as what would require a custom build:
- Additional requirements in the sandbox via
CODEJAIL_EXTRA_PIP_REQUIREMENTS. - A different version of python for the sandbox environment via
CODEJAIL_SANDBOX_PYTHON_VERSION. - Custom version of edx-platform that changes the contents of
requirements/edx-sandbox.
One plugin that includes a section like this is tutor-ecommerce.
MoisesGSalas
approved these changes
Jun 19, 2024
README.rst
Outdated
| @@ -1,7 +1,8 @@ | |||
| Codejail plugin for `Tutor`_ | |||
| ============================ | |||
|
|
|||
| Tutor plugin that enables execution of untrusted code in secure sandboxes using an external `service`_ based on the `codejail`_ library. | |||
| Tutor plugin that configures and runs Codejail using a REST API service. Codejail allows for the | |||
There was a problem hiding this comment.
Overall I think is good to go, but if you have time can you include the link to the edunext/codejailservice repository?
mariajgrimaldi
approved these changes
Jun 19, 2024
dcoa
force-pushed
the
dcoa/readme-improvement
branch
from
b3d44df
to
2d25f97
Compare
fgosew
added a commit
to fgosew/tutor-contrib-codejail-sagemath
that referenced
this pull request
Jul 2, 2024
* docs: improve README (eduNEXT#56) * improve install instructions * include custom image section * enhance description --------- Co-authored-by: Maria Grimaldi <[email protected]> * feat: redwood support (eduNEXT#54) Add two new variables to enable the use of custom versions/forks of `edunext/codejailservice`. BREAKING CHANGE: the default Python version of the sandbox environment has been bumped to 3.11. This change alongside the upgrade of the SciPy and NumPy dependencies may cause some instructor code to fail. --------- Co-authored-by: Diana Olarte <[email protected]> Co-authored-by: Maria Grimaldi <[email protected]> Co-authored-by: Moisés González <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR has the goal of improving the plugin description throughout the README.
Also, I would like to change the repository description for the current introduction:
JIRA