This is the codeAbility Sharing Platform! Learn more about the codeAbility Sharing Platform.

Skip to content
Snippets Groups Projects
Commit 81cd571f authored by Administrator's avatar Administrator
Browse files

Update README.md

parent 8d8c9278
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 66 additions and 43 deletions
README.md
+ 66
− 43
View file @ 81cd571f
# CodeAbility Sharing Platform V0.0 # CodeAbility Sharing Platform V0.0
This is an initial version V0.0 of the CodeAbility Sharing platform. The goal This is an initial version V0.0 of the CodeAbility Sharing platform. The goal
of this initial version is to - allow an initial exchange of resources (e.g., of this initial version is to
lab exercises, lecture slides, collections of links, or Artemis exercises), -
give us a first concrete impression on available material to be shared. - allow an initial exchange of resources (e.g., lab exercises, lecture slides,
- collections of links, or Artemis exercises),
- give us a first concrete impression on available material to be shared.
This prototype uses the community edition of GitLab, which, among others, This prototype uses the community edition of GitLab, which, among others,
provides a web-based Git repository manager. Therefore, the well-known and provides a web-based Git repository manager. Therefore, the well-known and
...@@ -13,41 +16,52 @@ following, the registration, usage, and plans are discussed. ...@@ -13,41 +16,52 @@ following, the registration, usage, and plans are discussed.
Our plans are to extend the usability and functionality of the sharing platform Our plans are to extend the usability and functionality of the sharing platform
step by step to make it more suitable to the project's needs. step by step to make it more suitable to the project's needs.
As a very first beginning the platform - is restricted to the closed user group As a very first beginning the platform
of project partners, - is expected to contain only material under the [CC-BY-SA
V4.0](https://creativecommons.org/licenses/by-sa/4.0/) license. (If this - is restricted to the closed user group of project partners,
condition is a severe problem for you, please let us know.) we will lift these
restrictions step-by-step and add further functionality when we progress with - is expected to contain only material under the [CC-BY-SA
the platform. V4.0](https://creativecommons.org/licenses/by-sa/4.0/) license. (If this
condition is a severe problem for you, please let us know.)
## 1. Registration The sharing platform is available on
#https://sharing-codeability.uibk.ac.at/. We would kindly ask you to use the We will lift these restrictions step-by-step and add further functionality when
#self-registration function and inform us via email (TODO email address). As we progress with the platform.
#soon as we verified your access permission, you can access all resources, which
#your colleges have been sharing. ## 1. Registration
## 2. Usage After your successful registration, a lot of features are available The sharing platform is available on https://sharing-codeability.uibk.ac.at/. We
#for you. In this evaluation phase, we focus on the three main use-cases - would kindly ask you to use the self-registration function and inform us via
#publish, view, and discuss resources. Those are described in the following. email (sharing-codeability@uibk.ac.at). As soon as we verified your access
permission, you can access all resources, which your colleges have been sharing.
### 2.1 Publish Resources For publishing resources, you can create new
#repositories in the group `sharing`/`<your university>`. Please, use an ## 2. Usage
#informative repository name when creating a new repository (currently, you
#cannot search for specific terms across all repositories). A repository can After your successful registration, a lot of features are available for you. In
#contain various resources like a course, an exercise, or a list of links. this evaluation phase, we focus on the three main use-cases - publish, view, and
#However, please ensure that you only join resources in a single repository that discuss resources. Those are described in the following.
#are somehow related and do not use a single repository as a large data
#container. ### 2.1 Publish Resources
For publishing resources, you can create new repositories in the group
`sharing`/`<your university>`. Please, use an informative repository name when
creating a new repository (currently, you cannot search for specific terms
across all repositories). A repository can contain various resources like a
course, an exercise, or a list of links. However, please ensure that you only
join resources in a single repository that are somehow related and do not use a
single repository as a large data container.
Moreover, you should include a `Readme.md`-File in each repository that Moreover, you should include a `Readme.md`-File in each repository that
comprises a description of the repository's content and possibly the comprises a description of the repository's content and possibly the
requirements (e.g., to solve the exercises). The latest version should always be requirements (e.g., to solve the exercises). The latest version should always be
available in the master branch. For further iterations of the course, version available in the master branch. For further iterations of the course, version
tags can be used. We recommend additional files - `LICENSE` (may contain the tags can be used. We recommend additional files
legal license terms) - `metadata.yaml` (as a first example see [some artemis
exercise](https://sharing-codeability.uibk.ac.at/sharing/university-innsbruck/java/general/junit-quality-tests-exercise/-/blob/master/metadata.yaml)). - `LICENSE` (may contain the legal license terms)
The format ist described
[here](https://sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/-/wikis/technical/MetaData) - `metadata.yaml` (as a first example see [some artemis
exercise](https://sharing-codeability.uibk.ac.at/sharing/university-innsbruck/java/general/junit-quality-tests-exercise/-/blob/master/metadata.yaml)).
The format ist described
[here](https://sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/-/wikis/technical/MetaData)
To improve the search experience of relevant repositories, you can provide To improve the search experience of relevant repositories, you can provide
topics and a project description (see `Settings`/`General`). As a reference, you topics and a project description (see `Settings`/`General`). As a reference, you
...@@ -56,17 +70,26 @@ repository](https://sharing-codeability.uibk.ac.at/sharing/university-innsbruck/ ...@@ -56,17 +70,26 @@ repository](https://sharing-codeability.uibk.ac.at/sharing/university-innsbruck/
Note that in this version, all resources are published under the license CC Note that in this version, all resources are published under the license CC
BY-SA. BY-SA.
### 2.2 View Resources After an interesting project was found in the shared ### 2.2 View Resources
#group `sharing`, the content can be viewed in the web browser, or the
#repository can be downloaded by Git means into your local repository. After an interesting project was found in the shared group `sharing`, the
content can be viewed in the web browser, or the repository can be downloaded by
Git means into your local repository.
### 2.3 Discuss Resources
For discussing the material or asking questions about the resources of a
repository, issues can be used.
## 3. Plans
For the immediate next steps, we think that the following extensions would be
beneficial.
### 2.3 Discuss Resources For discussing the material or asking questions about * Full-text search across all repositories
#the resources of a repository, issues can be used.
## 3. Plans For the immediate next steps, we think that the following extensions * Support for EduID
#would be beneficial.
* Full-text search across all repositories Support for EduID Collection and * Collection and search for metadata
* search for metadata
These features will be made available as soon as they are available. These features will be made available as soon as they are available.
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment