search

cogimon / cogimon.github.io

COGIMON Top-Level Documentation
GNU Lesser General Public License v3.0
1 stars 4 forks source link

Moving all documentation to this place #36

Open Pouya-moh opened 6 years ago

Pouya-moh commented 6 years ago

Part of the documentation is hosted outside of this repo. For instance our dependencies are listed listed in toolkit.cit-ec.uni-bielefeld.de. As result, to fix certain issues of the documentation we cannot act directly. For instance recently I noticed some missing dependencies (#35) but I can't directly act upon.

@swrede please make the call here.

warp1337 commented 6 years ago

What do you mean by

but I can't directly act upon.

?

Pouya-moh commented 6 years ago

Say, I want to modify that page and add a missing dependency. It's an external page/repository which don't have access to. I have to ask someone from Uni-Bielefeld (e.g., you, Dennis, etc) to modify it.

warp1337 commented 6 years ago

Hey! Okay, I understand what you mean. The site you referenced, is not the actual documentation. The site is just a human readable snapshot of the target system. If you want to change dependencies, you need to edit the recipes that have been used to generate the distribution aka system. You can find the recipes here:

https://opensource.cit-ec.de/projects/citk/repository

You are still correct though, you would need an account for opensource in order to change things. That's pretty easy to setup. You should talk to @swrede about that.

However, the real user documentation regarding the CITK can be found here:

https://toolkit.cit-ec.uni-bielefeld.de/tutorials/bootstrapping https://toolkit.cit-ec.uni-bielefeld.de/tutorials/installing https://toolkit.cit-ec.uni-bielefeld.de/tutorials/writingrecipes https://toolkit.cit-ec.uni-bielefeld.de/tutorials/writingdistributions https://toolkit.cit-ec.uni-bielefeld.de/tutorials/buildgen

As I said earlier, the system view in the toolkit.cit-ec.de is rather a human readable version of a current snapshot of the system. Morever, it is possible to update this snapshot, if desired. Here, also @xwavex or @swrede probably the right contact person.

Hope that helps!