|
|
|
# Sharing Contents from Artemis on the Sharing Platform
|
|
|
|
|
|
|
|
_Sorry, this page is currently only available in english!_
|
|
|
|
_Sorry, this page is currently only available in English!_
|
|
|
|
|
|
|
|
For the time being, we have implemented an initial infrastructure to export artemis programming exercises to the sharing platform. To do so, follow the steps below:
|
|
|
|
For the time being, we have implemented an initial infrastructure to export Artemis programming exercises to the sharing platform. To do so, follow the steps below:
|
|
|
|
|
|
|
|
### Setup repository group
|
|
|
|
|
|
|
|
1. Register in the sharing plattform (unless not already done), an require the administrator role for the "sharing"-group permission.
|
|
|
|
1. Register in the [Sharing Plattform](https://search.sharing-codeability.uibk.ac.at/) (unless not already done), an require the administrator role for the "sharing"-group permission.
|
|
|
|
|
|
|
|
2. Create a new subgrup below the sharing-hierarchy and your university (e.g. https://sharing-codeability.uibk.ac.at/sharing/university-innsbruck/). ***Skip this step if the subgroup you want to import the exercise to, already exists***
|
|
|
|
|
|
|
|
### Export exercise from Artemis
|
|
|
|
|
|
|
|
1. Log in into Artemis and navigate to an exercise's detail page
|
|
|
|
1. Login into [Artemis](https://artemis.codeability.uibk.ac.at/)
|
|
|
|
|
|
|
|
2. Click the following export button:
|
|
|
|
2. Navigate to the course management page and click  of the course containing the exercise you want to share
|
|
|
|
|
|
|
|
|
|
|
|
3. Click on the **Title** (or **ID**) of the exercise (this will navigate you to the exercise's detail page)
|
|
|
|
|
|
|
|
3. You will be redirected to the following Sharing Platform import's page, where the exercise's metadata can be reviewed and adapted:
|
|
|
|
4. Click the  button. (You will be redirected to the [Sharing Plattform](https://search.sharing-codeability.uibk.ac.at/))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4. As the metadata will be correctly filled in, the *'submit'* button at the bottom of the page will be activated. By clicking this button, a popup window containing a list of all visible Gitlab groups will appear, asking you to choose where the exercise should be imported:
|
|
|
|
|
|
|
|
|
|
|
|
5. Login using your credentials or through **Gitlab SSO** in the [Sharing Plattform](https://search.sharing-codeability.uibk.ac.at/)
|
|
|
|
|
|
|
|
5. The import will be performed as you select a Gitlab group. Afterwards, you will be redirected back to Artemis
|
|
|
|
6. An **Import exercise** page will be displayed, were you can edit the metadata of the imported exercise (*this won't affect the exercise in Artemis*)
|
|
|
|
|
|
|
|
## Previous method for importing exercises into Sharing Platform
|
|
|
|
|
|
|
|
|
|
|
|
1. Register in the sharing plattform (unless not already done), an require the administrator role for the "sharing"-group permission.
|
|
|
|
2. Create an empty git project in the gitlab platform, below the sharing-hierarchy and your university (e.g. https://sharing-codeability.uibk.ac.at/sharing/university-innsbruck/).
|
|
|
|
3. Clone this (empty) project onto your local computer in a temporary directory.
|
|
|
|
4. Export your project from Artemis by using the Export button on the exercise view page:
|
|
|
|
|
|
|
|
7. After filling out the **import form**, click the  button (A list of Gitlab groups for which you have the needed permissions will be displayed)
|
|
|
|
|
|
|
|
This will download a zip file, which is already in the correct structure, to share it on the sharing plattform.
|
|
|
|
|
|
|
|
|
|
|
|
5. Expand this zip file in the temporary directory.
|
|
|
|
6. Review the information in `metadata.yml`. Some data may not yet be optimal
|
|
|
|
- Title: is the title meaningful outside Artemis
|
|
|
|
- Description: add a short description of the exercise. May be you can copy a synopsis from the long exercise description (you may find this in `exercise.md`)
|
|
|
|
- Keywords: Are the keyword adequate for finding your exercise
|
|
|
|
- License: Is the copyright license OK for you? You can replace it by any other license.
|
|
|
|
7. Commit and push your content to the sharing plattform gitlab.
|
|
|
|
8. If your metadata.yml does not yet conform to the requirements [see MetaData Documentation](technical/MetaData Documentation), you will be notified by email.
|
|
|
|
9. Check the result on the sharing plattform
|
|
|
|
10. By default your exercise will only be visible by other members of the sharing group. Please consider to make access public, by changing it under "Settings -> General -> Visibility ..."
|
|
|
|
|
|
|
|
8. Select the Gitlab group were you want to store/share the exercise (*This might take several seconds to complete*)
|
|
|
|
|
|
|
|
Remark: We are currently working on a smoother export to the sharing plattform :-) |
|
|
\ No newline at end of file |
|
|
|
9. Upon successful import, you will be redirected back to Artemis |
|
|
\ No newline at end of file |
