Submitting Documentation

    See Contributing to Projects for general instructions on contributing to Vaadin. You should separate enhancements, fixes, and new features into different pull requests. Check your changes for basic style violations.

    To submit a contribution, you need to create a feature branch and push that for review.

    As a contributor, you need to:

    1. Fork the repository in GitHub.

    2. Clone it locally to edit it.

      Show code

      bash

      Expand code

    3. Make a new branch for the improvements.

      Show code

      bash

      Expand code

    4. Make the changes.

      Show code

      bash

      Expand code

    5. Push the changes to the branch in your forked repository.

      bash

      Expand code

    6. Create a pull request in the Docs repository.

      1. Your change should show there.

        Click Compare & pull request.

      2. In the Open a pull request form, enter a title for the PR, an optional comment, and click Create pull request.

    7. Make and push fixes requested in the review.

      Note that you do not need to set the upstream again, but can just git push the changes.

      Show code

      bash

      Expand code

    Vaadin Developers

    Vaadin developers with write access to the Docs repository should (like above):

    1. Clone the repository to edit it.

    2. Make a new branch for the improvements.

    3. Make the changes.

      • Preview locally while writing.

    4. Push the changes to the new branch in the Docs repository.

      1. Open the Docs repository page in browser.

      2. Your change should show there.

        Click Compare & pull request.

    6. Add reviewers

      • Review in the development team.

      • Component code examples (TypeScript and Java) need to be approved by tomivirkki, , or yuriy-fix.

      • Can add for documentation style review, or ask to do separately outside the development time box.

      • No dedicated proofreader is currently available, but magi42 can be asked for review.

    7. Make fixes requested in the review.

    8. Merge the PR by yourself or have the team lead or main author do it.

    Merging a pull request has the following requirements:

    • The PR must have been accepted in review

    • Deployment preview build must finish successfully

    • You must have signed the Contributor License Agreement

    The following requirements are optional and not enforced:

    • Vale checks are successful

    For contributions, the reviewer merges the pull request once it has been approved.