| ... | ... | @@ -10,7 +10,7 @@ You are welcome to contribute. In the following we want to guide you through the |
|
|
|
|
|
|
|
In the following we try to guide you through the basic process of publishing on the sharing plattform.
|
|
|
|
|
|
|
|
## 1\. Decide on the format of the material you want to share
|
|
|
|
## 1. Decide on the format of the material you want to share
|
|
|
|
|
|
|
|
You share your material via a gitlab repository. So there are little technical restrictions on the structure and contents of your contribution.
|
|
|
|
|
| ... | ... | @@ -41,11 +41,11 @@ For **lecture material** we recommend the following formatting priorities |
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
## 2\. Decide on the location of your contribution
|
|
|
|
## 2. Decide on the location of your contribution
|
|
|
|
|
|
|
|
The backbone of the sharing platform is a gitlab instance at https://sharing-codeability.uibk.ac.at/. You should locate your contribution in an appropriate sub folder below your institution (e.g. https://sharing-codeability.uibk.ac.at/sharing/johannes-kepler-university-linz/java/Einfuehrung1/...)
|
|
|
|
|
|
|
|
## 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.
|
|
|
|
|
| ... | ... | @@ -58,7 +58,7 @@ In order to provide future services we would propose the following structure: |
|
|
|
3. for complex content of exercises we _recommend_ the following folder structure: a. an **exercise** folder: should contain all basic files, a student needs to start solving the exercise b. a **solution** folder: should contain the sample solution of the exercise c. a **test** folder: should contain the infrastructure to test a submitted exercise for its validity
|
|
|
|
4. any futher 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
|
|
|
|
|
|
|
|
For sharing, we recommend to make your project **public** in gitlab.
|
|
|
|
|
| ... | ... | @@ -80,7 +80,7 @@ Which makes the project findable by any user. However the download-zip does not |
|
|
|
|
|
|
|
You can find more information on the help page on [permissons](de/publishers/permissions).
|
|
|
|
|
|
|
|
## 5\. Provide helpful metadata
|
|
|
|
## 5. Provide helpful metadata
|
|
|
|
|
|
|
|
The metadata.yaml is _mandatory_ (alternatively a metadata.yml or a metadata.js is also appropriate). It contains information about your exercise, necessary to discover it by an interested user.
|
|
|
|
|
| ... | ... | @@ -133,9 +133,9 @@ subject: |
|
|
|
- "Universität Innsbruck-Einführung in die Programmierung"
|
|
|
|
```
|
|
|
|
|
|
|
|
Please refer to the [documentation of metadata](https://sharing-codeability.uibk.ac.at/development/sharing/codeability-sharing-platform/-/wikis/Metadata/MetaData-Documentation) for a full up-to-date reference of the available fields.
|
|
|
|
Please refer to the [documentation of metadata](https://sharing-codeability.uibk.ac.at/development/sharing/codeability-sharing-platform/-/wikis/Metadata/Metadata-Version-0.5-Documentation) for a full up-to-date reference of the available fields.
|
|
|
|
|
|
|
|
## 6\. Maintain your contents
|
|
|
|
## 6. Maintain your contents
|
|
|
|
|
|
|
|
Every time you push a new commit to the master branch, the project is checked for the presence of the metadata file. If it is not present, or its content is not valid, you will get an error mail, pointing out the problem.
|
|
|
|
|
| ... | ... | |