| ... | ... | @@ -46,7 +46,7 @@ You should locate your contribution in an appropriate sub folder below your inst |
|
|
|
|
|
|
|
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:
|
|
|
|
1. a metadata.yaml is _mandatory_ (alternatively a metadata.yml or a metadata.json is also appropriate), See further information below.
|
| ... | ... | @@ -61,12 +61,22 @@ In order to provide future services we would propose the following structure: |
|
|
|
|
|
|
|
For sharing, we recommend to make your project **public** in gitlab.
|
|
|
|
|
|
|
|
If you are reluctant to make your exercise public, you can make your project private and open it only for a certain group of members. The sharing platform cares for the appropriate group memberships of all its users.
|
|
|
|
If you are reluctant to make your exercise public, you can make your gitlab project private and open it only for a certain group of members.
|
|
|
|
The sharing platform cares for the appropriate group memberships of all its users.
|
|
|
|
|
|
|
|
Currently the default is, that your project is shared under the **sharing** group, which comprises all codeability partners.
|
|
|
|
|
|
|
|
If you decide to make your exercise public, please note that also every parent group must be public.
|
|
|
|
|
|
|
|
For private projects there is an explicit mechanism to make only parts of the project publicly available: you can use the special attribute ```publicVisibility```, e.g.
|
|
|
|
```yaml
|
|
|
|
publicVisibility:
|
|
|
|
except:
|
|
|
|
- "solution"
|
|
|
|
|
|
|
|
```
|
|
|
|
Which makes the project findable by any user. However the download-zip does not contain the folder ```solution```.
|
|
|
|
|
|
|
|
## 5. Provide helpful metadata
|
|
|
|
|
|
|
|
The metadata.yaml is _mandatory_ (alternatively a metadata.yml or a metadata.js is also appropriate).
|
| ... | ... | @@ -120,7 +130,7 @@ subject: |
|
|
|
- "Universität Innsbruck-Einführung in die Programmierung"
|
|
|
|
```
|
|
|
|
|
|
|
|
Please refer to the documentation of [metadata version 0.4](https://sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/-/wikis/technical/Metadata-Version-0.4-Documentation) for a full reference of the available fields.
|
|
|
|
Please refer to the documentation of [metadata version 0.4](https://sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/-/wikis/technical/Metadata-Version-0.4-Documentation) for a full up-to-date reference of the available fields.
|
|
|
|
|
|
|
|
## 6. Maintain your contents
|
|
|
|
|
| ... | ... | |