Contributing to Vaadin Documentation
You can click the Edit this article link at the bottom of any page to start making a contribution through GitHub. After editing, make a pull request. You should pay note to the instructions and limitations for editing in GitHub.
|
Note
|
GitHub editor has limitations
The preview in the GitHub editor has limitations.
|
If you make code contributions that change the behavior of Vaadin products, the new behavior always needs to be documented. Documentation should be done along with any such feature additions or changes. Hence, if you develop any features for the Vaadin products, you need to be familiar with the documentation tools and processes.
- Editing Tools
-
Gives instructions for editing and previewing documentation. The easiest way is to edit GitHub, but it has limitations. You can use any editor, but some support highlighting and previewing. You can also do preview with various external tools.
- Content Guidelines
-
Gives tips about the basic structure and content of product or feature documentation. Describes various aspects which you could consider for the documentation.
- Formatting with AsciiDoc
-
Vaadin documentation is currently written in the AsciiDoc format. We follow certain special conventions of using AsciiDoc. This document gives introduction to basic document structure and format. Emphasis should be done with special style names, and so forth.
- "Style Guidelines"
-
Gives style guidelines for formatting and the use of English language in various special cases.
- "Documentation Process"
-
Explains how documentation should be done as part of the software development process.
Contributing to Vaadin Products
Source code for Vaadin products is available from GitHub at github.com/vaadin.
Its ticket system is the primary way to file bug reports and make feature requests.