[SMW-devel] RFC: Technical documentation, installation instructions and release notes

2013-11-05 Thread Jeroen De Dauw
Hey, We have been both shipping documentation together with the source code (as text files) and providing it on the SMW wiki since I joined the project. I see some problems with this. If the documentation is at both places, it doubles the maintenance effort. Given we have quite little resources

Re: [SMW-devel] RFC: Technical documentation, installation instructions and release notes

2013-11-05 Thread James HK
Hi, +1 When I started re-factoring classes and objects, I first thought that the SMW wiki would be the right place for keeping track of such effort but it soon became apparent that maintaining such information on-wiki is not worth energy and therefore I retreated from the wiki as technical

Re: [SMW-devel] RFC: Technical documentation, installation instructions and release notes

2013-11-05 Thread Markus Krötzsch
Hi Jeroen, different answers for different questions: +1 to have detailed release notes in the source code (and nowhere else). The wiki will always have news items and SMW version pages that describe the main changes in a release; the release note file in the source can be linked from the