Highlights from our first Vaadin Docs hackathon

Mikael Sukoinen
Mikael Sukoinen
On Feb 23, 2023 1:42:14 PM

Our documentation team invited the rest of Vaadin to work on the docs during a hackathon-style “documentation week,” focusing on fixing issues and improving the quality of the Vaadin Docs repository. Now, we extend the invitation to all Vaadin community members!

Technical documentation is at the heart of Vaadin: it shows new users how to get started and describes the key concepts, functionalities, and architecture.

The Vaadin documentation is open-source, just like the software it documents.

Visit Vaadin Docs -->

The result of Vaadin documentation week

We had 24 people contribute 73 pull requests, which resulted in 22 closed problems in the documentation repository. Our services department, community members, and customers sourced the issues. We expect even more issues to be closed once we finish reviewing the remaining PRs left from last week. 

The closed issues varied from missing images to entire new articles. Highlights include more examples for the Flow Keyboard Shortcuts API, details about the `NonNullApi` and nullability annotation collision for Hilla, and a new tutorial for using SSO Kit together with Keycloak.

Do you want to join the effort?

We continue improving the quality of Vaadin Docs by adding to it and by finding and fixing issues. Like any open-source project, you’re invited to join the effort!

There are many ways to contribute to the Vaadin Docs. You may:

  1. File an issue to the Docs repository if you encounter any bugs or other flaws, such as missing, false, or outdated information. You can find instructions for reporting in the Vaadin Github repository.
  2. Contribute to the documentation by fixing reported issues or finding an issue to fix! You can find instructions for authoring in the Vaadin Docs. 
  3. Comment and share your code examples in the comments section at the bottom of a Docs article.

Every pull request is suspect to both a technical and language review before approval, so you don’t have to worry about mistakes when contributing. Joining the documentation effort also increases your chances of being recognized as a Vaadin Community Award winner, which is an annual prize we reward our most active community members.  

If you haven’t already, you can join the chat on Discord or ask and answer questions on StackOverflow to stay in touch with the Vaadin Community!

Finally, I'd like to thank everyone, both internal and external contributors, who took the time to offer their expertise for the Vaadin documentation. I hope to see you again soon!

Visit Vaadin Docs -->

Mikael Sukoinen
Mikael Sukoinen
Mikael has a passion for writing text, code and music. He’s currently utilising his skills to explain difficult concepts in plain language at Vaadin Ltd.
Other posts by Mikael Sukoinen