Extend Documentation/Guides for Vaadin and Quarkus with Gradle Kotlin Script

オープン
#4,183 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
kotlin

調査の方向性

Vaadin Quarkus 統合ドキュメントと、リポジトリ base-starter-flow-quarkus の gradle バリアントから始めます。Gradle Kotlin Script における本番モードとネイティブ実行可能ファイルの設定の違いを確認し、その後、ガイドの配置場所と範囲を提案します。文書化された Gradle ワークフローがセットアップ、本番ビルド、ネイティブ実行可能ファイルをカバーすれば完了です。

索引モデルが issue の本文から書いたものです。

説明

flow

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.

主要言語
AsciiDoc
スター
38
フォーク
225
平均マージ
17時間 38分
マージ済み PR(30日)
214

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

vaadin/docs のほかの issue

vaadin/docs の issue をすべて見る

似ている issue

Build System の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。