Dokumentation of used software in markdown
It would be great to have more extensive documentation covering the software used by BiBiGrid (slurm, Ansible, ...). This should be done in markdown as part of the repository.
A few questions arose while thinking about the further documentation:
- To what degree shall we document software used in BiBiGrid? A reference to the original documentation is very helpful, but citing that documentation within the BiBiGrid documentation should be very sparse in order to avoid overloading the BiBiGrid documentation. I think only listing a few options within the BiBiGrid documentation should be enough.
- To what degree shall we document the internal BiBiGrid processes? While explaining how to determine after-launch-cloud-provider-services in order to name them in the
bibigrid.yml
is very helpful for the common user, explaining how the ide port forwarding works is probably not. I think that only listing those internal processes that may directly affect the user experience is a good focus for now.
Edited by Xaver Stiensmeier