ドキュメントのVuePress化

[shufo]

改善詳細 / Details of Improvement

問題点

• 現在のドキュメントはMarkdownベースになっているけどGitHub上でホスティングされているためリンクの遷移に時間がかかる
  • 新規ContributerのOnboardingに時間がかかる
  • Contributerの開発体験があまりよくない -> Contributionの機会が減る

改善方法

• 現在の docs ディレクトリ以下をVuePressで静的サイトとして出力する
  • why vuepress?: markdownドキュメントをstaticなhtmlとして出力が出来て現在のdocsディレクトリ以下のドキュメントをほぼそのまま利用出来るため
    • 現状のMarkdownドキュメント更新のフローは変更不要
  • またPWAとして出力することも出来るのでサーバに負荷がかかりづらい→ネットワークリソースの使用が増えてインフラが不安定になることが多い昨今GitHubに依存しない状況を作れてネットワークリソースの削減にも貢献出来る
  • 開発者も1人のユーザのため UX（ユーザエクスペリエンス）を大切にする というCode of Conductに貢献出来る
  • VuePress自体Vue製なので本体のComponentをいじっている人もドキュメントサイトの更新やカスタマイズがしやすい

スクリーンショット / Screenshot

PoCとして試しにdocsディレクトリをVuePressで出力してみたGifです（読み込みに少し時間がかかります）

上記Gifでやっていること

• SPAでの遷移
• 多言語切り替え
• ドキュメントの検索

期待する見せ方・挙動 / Expected behavior

実現方法

• 本番URLの https://stopcovid19.metro.tokyo.lg.jp/ と同一ドメインにドキュメントをホスティングする （現在のビルドパイプラインにvuepressを追加するだけなので比較的簡単）

  • URL例:
    • https://stopcovid19.metro.tokyo.lg.jp/docs/
    • https://stopcovid19.metro.tokyo.lg.jp/guides/ など

• もしくはドキュメント用のサブドメイン 例: https://docs.stopcovid19.metro.tokyo.lg.jp/ を用意する（サブドメイン作成等必用のためハードル高い？）

• リポジトリトップのREADMEにVuePressへのリンクを追加する

---

ドキュメント周りの用語を検索してそれらしいissueが見つからなかったため起票しました