|
Re: [Blog Post] Documentation Platform for Eclipse Scout [message #1695256 is a reply to message #1694878] |
Wed, 13 May 2015 06:16 |
Urs Beeli Messages: 573 Registered: October 2012 Location: Bern, Switzerland |
Senior Member |
|
|
I can see the need for a unified approach and the one you are proposing makes sense.
However, as someone having contributed both to the Wiki and the code base by contributing some code patches the one sentence that made me pause is the following:
Quote:Use a git repository instead of a wiki to ease the maintenance on different branches.
Again, I can see why you are doing this, and it makes sense. But this will make the barrier to contribute to the documentation much higher. I have written dozens of "how to" pages on the wiki and that was trivial and cost me little time. However, as someone unfamiliar with git and sitting behind a corporate firewall, contributing three relatively small code patches took me several days and the support of someone from bsi to set up the infrastructure and to walk me through using git/gerrit correctly. If your new system is introduced the consequence for me will be that I will no longer be able to contribute to the Scout documentation as I just don't have time to put up with the whole git setup.
As an open source project, I agree documentation is vital, but if you want the community to contribute it also needs to be easy to do so. I fear that this step - while probably necessary - will make this harder than it is now.
So as a suggestion, I would encourage you to look at a way for the community to contribute documentation with a minimum of technical hassle and barriers (i.e. a way to contribute to documentation without having to go through git).
|
|
|
|
|
Powered by
FUDForum. Page generated in 0.04176 seconds