[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [egit-dev] EGit Documentation and User Guide
|
2010/2/8 Chris Aniszczyk
<zx@xxxxxxxxxxxxxxxxx>
Hey guys, in the next coming days I plan on finishing up the first cut
of the EGit documentation (still needs some love).
http://egit.eclipse.org/r/#change,276
The documentation will be sourced from the wiki
http://wiki.eclipse.org/EGit/User_Guide
And turned into Eclipse help via a build script and the help of Mylyn Wikitext.
Are people comfortable with this approach? I believe it lowers the
barrier of documentation contribution quite a bit. Changes would be
pulled manually whenever we wanted too. This approach has worked well
for the Mylyn project which sources its documentation from the wiki:
http://wiki.eclipse.org/index.php/Mylyn_User_Guide
I like this approach very much and just wanted to get feedback from
people before I start locking things down.
That's what we accepted on when we started writing the user guide in the EGit wiki. I still think this is a very
good way to get our documentation on the web and in Eclipse help created from one source. What I like most
with this approach is that this way the documenation can also be easily improved by our users with a very
low contribution barrier.
--
Matthias
