Documentation site on github

[Julien Dramaix]

Dear GWT Community,

In order to increase the number of contributions on the GWT documentation, we've decided to move the documentation on Github and accept pull requests.

We have also spent time to convert all the documentation in markdown syntax. In addition to that, each documentation page has now an edit button. When you click on, you are redirected to the corresponding markdown page on Github in edit mode. You can easily modify a page and when you save your change Github will automatically fork the project (if needed) and creates a pull request for you. 

This is for the documentation only, the code for GWT will stay on gerrit, simply because gerrit is a much powerful tool to do code review of code.

Julien

[Michael Prentice]

This is great news and will enable more people to contribute to the documentation in meaningful ways without needing to become fully versed in Gerrit and the review system.

Any plans to remove the 'This is a beta version' from the header (main.tpl) of the gwtproject.org site?

[Rene Hangstrup Møller]

I just tried this out, but it seems there is a difference in the way github and gwtproject renders markdown.

I saw that the bullets on the UIBinder page were not rendered properly, but on github they look right.

https://github.com/gwtproject/gwt-site/pull/45

/Rene

[Thomas Broyer]

On Wednesday, February 11, 2015 at 9:50:34 AM UTC+1, rhmoller wrote:

I just tried this out, but it seems there is a difference in the way github and gwtproject renders markdown.

I saw that the bullets on the UIBinder page were not rendered properly, but on github they look right.

Yes, because there's not "one" markdown (just like there's not "one webkit" or "one chromium")

This is why we have http://commonmark.org/ but implementations have not updated to that spec yet (which isn't even finished).

In this case, I think the difference is in whether there should be a blank line before the first bullet or not. See http://spec.commonmark.org/0.17/#example-201

[Kay Pac]

I've been unable to find the "JUnit.html" page in the github gwt-site depot. The url is: http://www.gwtproject.org/doc/latest/tutorial/JUnit.html

Any help?

[Hristo Stoyanov]

How about using www.gitbook.com? 

Several OSS projets are doing it, their docs look great, for example: www.keycloak.org/documentation.html