Skip to content
Andreas Ofner edited this page Jul 31, 2016 · 3 revisions

GWT Documentation

Making GWT better

Contributing to webpage and Documentation

This webpage and the documentation hosted on it are completely written in markdown. If you find an error, want to make an improvement, write an article or do something to the webpage feel free to do so.

Here is how it works:

All the code is stored on github and can be directly edited on the web by pressing the "Edit me on Github" button. This is the easiest way to make a change, but if you are planing to make bigger changes to the website and want to test these locally first, you can clone the repository:

git clone https://github.com/gwtproject/gwt-site

The source code for this webpage will be found in src/main/markdown. You can edit existing files and add new ones. If you want to see your changes you will need to run:

mvn clean install

After that you can go to target/generated-site and see the generated site.

You can also launch the embedded Jetty server with

mvn jetty:run

and point your browser to http://localhost:8080.

If you think your change is ready to be published on gwtproject.org you can send us your changes with a pull request to http://github.com/gwtproject/gwt-site.

If you wish to contribute to the GWT code used on the site (to improve navigation), then you should

git clone https://gwt.googlesource.com/gwt-site-webapp

Global .gitignore

Since our .gitignore files don't contain IDE or OS specific .gitignore entries you should setup your global .gitignore.

This is how you setup a global .gitignore.

Here you find a list of IDE specific global .gitignore files.