Hello, One of the problems of EasyBuild (and any other open source software) is the lack of up-to-date documentation. In the case of EasyBuild, the several outdated pages on the EasyBuild wiki [1].
Working on documentation is certainly not the most interesting type of work that can be done on a software project, but it essential when lots of new people are getting involved. No documentation is bad, but outdated/wrong documentation is even worse... For EasyBuild, we have been relying on the GitHub wiki of the main EasyBuild repository for documentation. Allowing the community to contribute to the documentation has proven difficult, because most people don't have edit rights. Basically, what we're missing is being able to let people open pull requests on wiki pages. Since GitHub doesn't provide this feature directly, we have set up a separate dedicated repository for the EasyBuild wiki [2]. As is described on [3], this enables EasyBuilders to now open pull requests for changes to the wiki pages, while we can easily keep both the wiki repository and the live EasyBuild wiki up-to-date. Moreover, it allows for actual collaborative efforts on the wiki, since we would like to see wiki pull requests reviewed, just like code pull requests. We hope this helps alleviate the problem of outdated documentation in the future, and would like to encourage everyone to actively contribute to the EasyBuild documentation. A (partial) list of wiki pages that need work are listed at [4], but do feel free to issue wiki pull requests for any documentation-related issues you may run into. regards, Kenneth [1] https://github.com/hpcugent/easybuild/wiki (note: easybuild <slash> wiki) [2] https://github.com/hpcugent/easybuild-wiki (note: easybuild <dash> wiki) [3] https://github.com/hpcugent/easybuild/wiki/Contributing-to-the-EasyBuild-documentation-wiki [4] https://github.com/hpcugent/easybuild/issues?state=open
