| ... | @@ -42,6 +42,10 @@ You should locate your contribution in an appropriate sub folder below your inst |
... | @@ -42,6 +42,10 @@ You should locate your contribution in an appropriate sub folder below your inst |
|
|
|
|
|
|
|
## 3. Decide on the structure of your contribution
|
|
## 3. Decide on the structure of your contribution
|
|
|
|
|
|
|
|
|
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".
|
|
|
|
|
|
|
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.
|
|
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.
|
|
2. a README.md is _recommended_. It should give a basic overview to the content of your contribution beyond the description in the metadata.
|
| ... | | ... | |