| ... | @@ -35,7 +35,7 @@ For **lecture material** we recommend the following formatting priorities |
... | @@ -35,7 +35,7 @@ For **lecture material** we recommend the following formatting priorities |
|
|
4. Online Formats: Google Slide, etc.
|
|
4. Online Formats: Google Slide, etc.
|
|
|
5. _less recommended_: pdf format, because it does not really support reuse of content
|
|
5. _less recommended_: pdf format, because it does not really support reuse of content
|
|
|
|
|
|
|
|
For **other material** decide what is best suited for a potential users. Most probably a README.md file may be appropriate to give a basic documentation and to link to other stuff.
|
|
For **other material** decide what is best suited for potential users. Most likely a README.md file may be appropriate to give a basic documentation and to link to other stuff.
|
|
|
|
|
|
|
|
## 2. Decide on the location of your contribution
|
|
## 2. Decide on the location of your contribution
|
|
|
|
|
|
| ... | @@ -49,13 +49,14 @@ The smallest publication unit on the sharing platform is a single exercise. |
... | @@ -49,13 +49,14 @@ The smallest publication unit on the sharing platform is a single exercise. |
|
|
You can combine various exercises into a collection, e.g. a complete course, or another thematic combiniation of exercises. Elements in the collections can either be other gitlab projects on the sharing plattform, or simply subdirectories of the collection project. You find more information in the [metadata description](https://sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/-/wikis/technical/MetaData-Documentation) in the section "collections".
|
|
You can combine various exercises into a collection, e.g. a complete course, or another thematic combiniation of exercises. Elements in the collections can either be other gitlab projects on the sharing plattform, or simply subdirectories of the collection project. You find more information in the [metadata description](https://sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/-/wikis/technical/MetaData-Documentation) in the section "collections".
|
|
|
|
|
|
|
|
In order to provide future services we would propose the following structure:
|
|
In order to provide future services we would propose the following structure:
|
|
|
1. a metadata.yaml is _mandatory_ (alternatively a metadata.yml or a metadata.json is also appropriate), See further information below.
|
|
|
|
|
2. a README.md is _recommended_. It should give a basic overview to the content of your contribution beyond the description in the metadata.
|
|
1. a metadata.yaml is _mandatory_ (alternatively a metadata.yml or a metadata.json is also appropriate), See further information below.
|
|
|
3. for complex content of exercises we _recommend_ the following folder structure:
|
|
2. a README.md is _recommended_. It should give a basic overview to the content of your contribution beyond the description in the metadata.
|
|
|
a. an **exercise** folder: should contain all basic files, a student needs to start solving the exercise
|
|
3. for complex content of exercises we _recommend_ the following folder structure:
|
|
|
b. a **solution** folder: should contain the sample solution of the exercise
|
|
- an **exercise** folder: should contain all basic files, a student needs to start solving the exercise
|
|
|
c. a **test** folder: should contain the infrastructure to test a submitted exercise for its validity
|
|
- a **solution** folder: should contain the sample solution of the exercise
|
|
|
4. any futher content (e.g. images), that may be needed to re-use the exercise .
|
|
- a **test** folder: should contain the infrastructure to test a submitted exercise for its validity
|
|
|
|
4. any further content (e.g. images), that may be needed to re-use the exercise.
|
|
|
|
|
|
|
|
## 4. Decide on the visibility of your contribution
|
|
## 4. Decide on the visibility of your contribution
|
|
|
|
|
|
| ... | | ... | |