Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moving all documentation to this place #36

Open
Pouya-moh opened this issue Dec 18, 2017 · 3 comments
Open

Moving all documentation to this place #36

Pouya-moh opened this issue Dec 18, 2017 · 3 comments

Comments

@Pouya-moh
Copy link
Contributor

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
Copy link
Collaborator

warp1337 commented Dec 18, 2017

What do you mean by

but I can't directly act upon.

?

@Pouya-moh
Copy link
Contributor Author

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
Copy link
Collaborator

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants