docs
docs copied to clipboard
Extend Documentation/Guides for Vaadin and Quarkus with Gradle Kotlin Script
Tell us about your request
I'm using the following tech stack:
- Quarkus
- Gradle (Kotlin Script)
- Kotlin
- Vaadin
While there is documentation available for the general usage of Vaadin with Quarkus it seems the Guide only tackles Maven-based projects. There is also a gradle groovy variant available, but only as source code and not with matching documentation.
What I came across were issues when trying to build the application in production mode, which works a bit differently when using Gradle compared to Maven. Also, there's additional configuration required when building native executables, which seems to be not documented anywhere.
Thanks to the help of @mcollovati I was able to resolve my issues and I would like to contribute my learnings in the form of a guide or similar to make it easier for future developers to get started with this tech stack.
I'm asking you for feedback about my idea - and if you like it - what would be a good location to contribute such a guide (or similar)?
If you think this issue is important, add a 👍 reaction to help the community and maintainers prioritize this issue.
@PDDStudio thank you very much for the issue and willing to help with documentation/guides.
This is indeed very important for us and for our users so we would very appreciate any contribution. There two things that we can propose as an immediate enhancement:
- Gradle examples for Vaadin Quarkus add-on, currently it's only for Maven, would be awesome to add similar codes for Gradle.
- Production builds - also has only Maven examples, but needs Gradle scripts for how to set up production build and exclude dev dependencies.
And also many other parts in Vaadin docs where we miss Gradle examples, but let's address this separately.
If you want to contribute, please share your examples and publish a pull request to https://github.com/vaadin/docs/pulls (see https://vaadin.com/docs/latest/contributing/docs), we will review and make necessary additions if needed.
@mshabarov thank you for your feedback and pointing me into the right directions!
I will create a pull request in the following days to improve the documentation and examples for the mentioned pages.