規程・ガイドライン集の更新ガイドライン

このガイドラインは、規程・ガイドライン集の各種ドキュメント類および公開サイトを更新するための開発フローについて記載します。

公開サイトの構成について

公開サイトは AWS Amplify でホストされた静的サイトです。Docusaurusという、ドキュメント公開用の静的サイトジェネレーターを利用しています。

サイト更新の大まかな流れ

GitHub Flowに準拠して開発します。

main ブランチが公開サイトと同期されるため、原則として main ブランチからブランチを切ってローカル開発し、main ブランチに対してプルリクエストを出してください。

作成するブランチの命名規則は厳密には定めませんが、何を行っているかわかりやすい名前で作成し、他のブランチや過去のブランチ名と極力かぶらないように作成してください。

プルリクエストのレビューおよびマージは原則として法人の理事が実施します。

ローカル開発

本リポジトリをクローンし、 npm install後に、 npm run startすることで、開発環境が立ち上がります。 フォルダー名やドキュメントのファイル名の変更をする際は、一度開発環境を停止してから変更しないとエラーが出ます。

Docusaurus を使ったサイト開発方法について、詳しくは Docusaurus のドキュメントを参照してください。

プルリクエスト～デプロイ

ローカルで開発後、main ブランチに対してプルリクエストを出してください。マージされると公開サイトにも自動で変更が反映されます（ビルド&デプロイに数分かかります）