doc: create maintainer.md

Author: aster-void

README.md

@@ -2,14 +2,35 @@
 
 ## 環境構築・コマンド
 
-`./docs/develop.md` を参照。
+`./docs/develop.md` を参照してください。
 
-## Guidelines
+## `contents` ガイドライン
 
 ### 一般
 
-フォーマッタは Prettier を用います。
-各フロントマッター (トップに書く YAML) のプロパティは `./docs/contents` に説明があります。
+- フォーマッタは Prettier を用います。
+- 各フロントマッター (トップに書く YAML) のプロパティは [./docs/contents](./docs/contents) に説明があります。
+
+### 画像ファイル
+
+- HEIC は対応していないので、 ImageMagick で他のフォーマットに変換してください。
+  - 例: `magick picture.HEIC picture.webp`
+- すべての画像ファイルは 1 MB 未満に抑えてください。既存のものを変更したり、 CI でチェックしたりはまだ実装してないです。
+
+  - ffmpeg や ImageMagick を使い、解像度を下げたり、画質 (Quality) を下げたり、WebP (or AVIF) に変換するなどができます。
+
+    - 例:
+
+      - `mogrify -resize 800x -quality 80 -format webp input.png`
+
+        - ImageMagick についてきます。
+        - コマンドの引数は見ての通り。
+
+      - `ffmpeg -i ./input.png -vf 'scale=1920:-1' -crf 10 output.avif`
+
+        - -> 50〜300kb 程度になります。AVIF の場合、多少 (数秒〜1分程度) 時間がかかります。
+        - `-vf scale={width}:{height}`: 画像の横幅。height が -1 のときは、横幅から計算する。
+        - `-crf`: 画像の圧縮率。大きいほうが圧縮率が高い。
 
 ### メンバー
 
@@ -23,28 +44,16 @@
 - サムネイルは縦横比 3:5 にクロップされます。
 
   - 可能なら 3:5 に近い画像を使い、
-  - できないかつクロップが許容できない場合は、 `fit: contain` と背景色 (`bg_color:`) を指定してください。
-
-- 画像サイズは 1MB 未満に抑えてください。 ffmpeg や ImageMagick を使い、解像度を下げたり、画質 (Quality) を下げたり、WebP (or AVIF) に変換するなどができます。
-
-  - 参考 <https://stackoverflow.com/questions/7261855/recommendation-for-compressing-jpg-files-with-imagemagick>
-  - 例:
-
-    - `mogrify -resize 800x -quality 80 -format webp *.png *.jpg *.jpeg`
-      - ImageMagick についてきます。
-      - コマンドの引数は見ての通り。
-    - `ffmpeg -i ./input.png -vf 'scale=1920:-1' -crf 10 output.avif`
-      - -> 50〜300kb 程度になります。AVIF の場合、多少 (数秒〜1分程度) 時間がかかります。
-      - `-vf scale={width}:{height}`: 画像の横幅。height が -1 のときは、横幅から計算する。
-      - `-crf`: 画像の圧縮率。大きいほうが圧縮率が高い。
-
-  - HEIC は対応していないので、 ImageMagick で他のフォーマットに変換してください。
-    - 例: `magick picture.HEIC picture.webp`
+  - できないかつクロップが許容できない場合は、 `thumbnail.fit: contain` と背景色 (`thumbnail.bg`) を指定してください。
 
 - 各記事のファイルサイズの合計は5 MB までに抑えてください。
   - 理想は 1MB 未満です。
-  - ファイルサイズの確認には、`ncdu` が使いやすいです。
+  - ファイルサイズの確認には、`ncdu` が使いやすいです。 `ls -alh` でも可能です。
 
 ### プロジェクト
 
 - サムネイルは縦横比 3:5 にクロップされます。
+
+## Maintenance
+
+- Website のメンテナンス担当者は、[`./docs/maintainer.md`](./docs/maintainer.md) を参照してください。

docs/develop.md

@@ -9,8 +9,12 @@
 
 ### ローカル
 
+Nix を使うか、以下のパッケージをインストールします。
+
 - (必須) Bun >= v1.2
-- 任意のエディタ <https://docs.astro.build/en/editor-setup/>
+- (必須) Node.js
+- (推奨) 任意のエディタ <https://docs.astro.build/en/editor-setup/>
+- (推奨) ImageMagick, ffmpeg
 
 ```sh
 bun install --frozen-lockfile

docs/maintainer.md

@@ -0,0 +1,15 @@
+# ut.code(); Website のメンテナンス担当者ガイド
+
+あなたのタスクは、以下のとおりです。
+
+## 1. 品質担保
+
+- 各ページの品質と開発体験の保持・改善に努めてください。
+- Website は組織の顔です。常に運営方針を反映してください。
+- その他必要だと思ったことは、自発的に行ってください。 (この README を更新するなど)
+
+## 2. 各種リマインド
+
+- イベント開催者に記事を書かせる (自分で書いてもよい)
+- ut.code(); に参加したメンバーにメンバーページを書かせる
+- プロジェクトにプロジェクトページを書かせる

shell.nix

@@ -3,5 +3,7 @@ pkgs.mkShell {
   packages = [
     pkgs.bun
     pkgs.nodejs-slim # required by astro to find sharp
+    pkgs.ffmpeg
+    pkgs.imagemagick
   ];
 }