covid19 icon indicating copy to clipboard operation
covid19 copied to clipboard

ドキュメント出力のためVuePressを追加 / introduce vuepress

Open shufo opened this issue 4 years ago • 1 comments

👏 解決する issue / Resolved Issues

  • refs: #4175

📝 関連する issue / Related Issues

  • #4175

⛏ 変更内容 / Details of Changes

  • npmの依存にVuePressを追加
  • VuePressのconfigを追加
    • i18n設定, 出力先, base url等
  • リポジトリルートのMarkdownファイル類をdocs以下に移動
    • vuepressがターゲットディレクトリより上位のディレクトリを参照しないため
  • 各言語のmarkdown微修正
    • h1レベルのheaderが複数あったがvuepressが複数h1には対応していないので1レベルずつ下げた
  • package.jsonにドキュメントビルド用のコマンドを追加
    • yarn run docs:dev VuePress開発サーバ起動
    • yarn run docs:build ドキュメントビルド
  • github actionの各種デプロイの前にドキュメントビルド用コマンド追加
    • dist/docs に出力
  • README.mdからドキュメントサイトと同一の冗長な記述を削除
    • 代わりにドキュメントサイトへのリンクを追加

📸 スクリーンショット / Screenshots

README.md

image

ドキュメントサイト

image

懸念点

  • リポジトリルートのREADME.mdの見せ方
    • ドキュメントが冗長になるので上記スクリーンショットのように冗長な記述をドキュメントサイトの方に移動したけど情報減らしすぎ?
  • ドキュメントサイトの見せ方
    • 各種文言等
  • デプロイ方法
    • 各種デプロイ前のnuxtビルド後にドキュメントをdist/docsに出力しているのでデプロイ対象の/docsに出力されるはずだけど

TODO

  • [ ] リポジトリルートのREADMEのリンク先をこのPRでproductionに向けてしまっているので、README更新用のPRを分離する
  • [ ] 開発者向けドキュメントにvuepress, ビルド方法に関する記述を追加
  • [ ] 細かい文言修正

shufo avatar May 20 '20 03:05 shufo

docs/README.mdですが、作業を開始されてからオリジナルのREADME.mdに変更があり、また今後も変更される可能性があるため、このプルリクエストをマージする直前に最新のものに合わせることをおすすめします。 ただし、今のREADME.mdのリンクテキストはリンク先のファイルの見出しをそのまま採用しただけなので、docs/README.mdではよしなに変更されるといいかと思います(「How to contribute translations」を各言語に翻訳するなど)。

munierujp avatar May 21 '20 11:05 munierujp

@shufo ながらく(ほんとうに長い間...)放置してしまいまして申し訳ありません...! 本日をもって対策サイトは閉鎖し、このリポジトリはアーカイブすることになりました。それに伴い、こちらのPRもクローズとさせてください。 こちらのPRのように運用効率化に関わるご提案は非常に貴重なものと思いますので、私たちもしばらく見守ろうと思っていました。ただ、自治体公式のリポジトリとしてなかなか判断が難しく、私たちも多くの知見を持ち合わせていないために、どのように進めていくべきか手探りであったことは確かです。

とにかくコントリビューターのみなさんからは多くのことを学びました。本当に感謝です!

kaizumaki avatar May 31 '23 07:05 kaizumaki