Contributing - Getting Started with Vaadin Documentation
 Edit This Page

Getting Started with Vaadin Documentation

Marko Grönroos, Vaadin Ltd.

To make quick corrections or suggestions to the Vaadin Docs, simply click the GitHub link in the upper-right corner of any page to start making a contribution through GitHub and then do a pull request. You should pay note to the instructions and limitations regarding editing in GitHub.

A more flexible way is to use a local editor and tools.

The basic tasks for contributing to Vaadin documentation are:

  1. Install editing tools

  2. Edit documentation

  3. Make a pull request in GitHub

  4. Make possible fixes requested by the reviewer

Clone the Product Repository

To edit the documentation of a particular product, you first need to clone the repository.

The product documentation is maintained in respective product repositories:

Vaadin Framework

http://github.com/vaadin/vaadin in the 7.7 branch or later for Vaadin 7, or master for Vaadin 8. Under documentation folder.

Vaadin Designer

http://github.com/vaadin/designer-documentation (documentation in a separate repository)

Vaadin Charts

http://github.com/vaadin/charts in the 3.2 branch, under documentation

Vaadin TestBench

http://github.com/vaadin/testbench under documentation

Vaadin Spreadsheet

http://github.com/vaadin/spreadsheet under documentation

Vaadin Elements

Documentation for Vaadin Elements is maintained in respective element repositories. Unlike other documentation, which is in AsciiDoc format, elements are documented in HTML, where you can also have live examples.

<vaadin-grid>

https://github.com/vaadin/vaadin-grid under demo

Previewing the Elements documentation is done differently from the general method.

Start by cloning the repository you want to edit. You should clone it somewhere else in your file system and then create symbolic link to it as described later.

For example, to clone the Vaadin Framework repository:

 $ git clone http://github.com/vaadin/vaadin -b 7.7