mirror-kt / ktor-doc-jp

Japanese Documentation for Ktor Framework

Home Page:https://jp.ktor.work/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

概要

Kotlin製WebFrameworkであるKtor日本語ドキュメントです。

(特にサーバサイドKotlinにおいては)有力な選択肢となるWebフレームワークだと考えており、 この日本語訳があることで日本においてKotlinの普及率が増えるきっかけになれば面白いなと思い翻訳しました。 (RailsやNuxt.jsなども、日本語訳があることが普及の追い風となったのではないかと考えています)

翻訳を手伝っていただけるContributerの方を(また、Maintenerも)募集しています。 また、Issue、Pull Request絶賛お待ちしています!

PullRequestについて

  • 着手方法
    • タイトル・説明・コミットメッセージ等は日本語で作成していただいて大丈夫です。
    • コミットメッセージに指定はありませんが、翻訳元ページがわかるようURL等を入れておくといいかもしれません。
    • 他の方と着手箇所が被ると悲しいことになるので、空コミットを入れてタイトルの銭湯に[WIP]とつけPRを作成することを推奨します。(PR作成が早かったほうを優先になります)
    • PRの説明文のところに着手対象のURLがあるとわかりやすいのでありがたいです。
  • 着手対象
    • 現在英語になっているページ、またはページの先頭に「この文章は機械翻訳を利用して翻訳されています。」と注意書きがあるページが対象になります。
  • 心構え的な
    • 原文を直訳するよりも、多少情報が落ちたとしても意訳して読みやすくするほうが良いと考えています
    • 仮に下手な翻訳だったとしても読み手にとっては無いよりもはるかに有益なので、自信が無くても是非挑戦してみてください!
    • 内容がわからないところは部分的に英語のまま残すのもアリだと思います。

開発方法

./develop.sh を実行後 localhost:4000 で修正中のドキュメントが閲覧できます。

About

Japanese Documentation for Ktor Framework

https://jp.ktor.work/


Languages

Language:JavaScript 45.6%Language:CSS 37.5%Language:HTML 13.7%Language:Kotlin 3.2%Language:Shell 0.1%