From f91a36bc66a3b3543218d91adb4cca03e9310021 Mon Sep 17 00:00:00 2001 From: Gui <51219838+gui-ace@users.noreply.github.com> Date: Sun, 21 Jun 2026 09:43:45 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20GitHub=E3=83=86=E3=83=B3=E3=83=97?= =?UTF-8?q?=E3=83=AC=E3=83=BC=E3=83=88=E3=81=A8CMS=E8=AA=8D=E8=A8=BC?= =?UTF-8?q?=E6=96=B9=E9=87=9D=E3=82=92=E6=95=B4=E7=90=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/README.md | 34 +---- .github/ISSUE_TEMPLATE/bug-report.yml | 98 +++----------- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/content-cms-i18n.yml | 140 -------------------- .github/ISSUE_TEMPLATE/operations.yml | 124 ----------------- .github/ISSUE_TEMPLATE/site-change.yml | 109 --------------- .github/ISSUE_TEMPLATE/task.yml | 35 +++++ .github/copilot-instructions.md | 5 +- .github/pull_request_template.md | 22 +-- AGENTS.md | 9 +- README.md | 2 +- docs/cms-write-workflow.md | 3 + 12 files changed, 75 insertions(+), 508 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/content-cms-i18n.yml delete mode 100644 .github/ISSUE_TEMPLATE/operations.yml delete mode 100644 .github/ISSUE_TEMPLATE/site-change.yml create mode 100644 .github/ISSUE_TEMPLATE/task.yml diff --git a/.github/ISSUE_TEMPLATE/README.md b/.github/ISSUE_TEMPLATE/README.md index f534bd7..94f71de 100644 --- a/.github/ISSUE_TEMPLATE/README.md +++ b/.github/ISSUE_TEMPLATE/README.md @@ -1,32 +1,8 @@ -# Issue Template Standards +# Issue Templates -このディレクトリは、Acecore 公式サイトの GitHub issue 入力項目を揃えるための基準です。Issue の受け入れ条件は本文とチェックリストを正とするため、issue form は「実装者が迷わず着手できる情報」を集める目的に絞ります。 +入力項目は、実装者が着手できる最低限に絞ります。 -## 共通化する部分 +- `不具合`: 表示崩れ、動作不良、ビルド失敗など。 +- `タスク`: 改善、コンテンツ、CMS、運用など。 -すべての issue template は、次の項目を同じ順序・同じ意味で扱います。 - -- 概要: 何をしたいか、何が起きているかを 1-3 行で書く。 -- 背景・目的: なぜ必要か、誰に影響するかを書く。 -- 完了条件: レビュー時に完了判断できるチェックリストを書く。 -- 対象範囲・除外範囲: 今回触る範囲と、意図的に触らない範囲を分ける。 -- 関連パス・URL: 画面 URL、リポジトリ内パス、関連 issue/PR、CMS 項目を書く。 -- 確認方法: 実行すべきコマンド、ブラウザ確認、運用確認を書く。 -- 補足: 権限、期限、制約、依存関係などを書く。 - -## 個別にする部分 - -個別項目は、その issue 種別でしか判断できない情報だけにします。共通項目で足りる情報を個別項目として重複させないでください。 - -- 不具合報告: 現在の挙動、期待する挙動、再現手順、発生環境、緊急度。 -- サイト改善・機能追加: 解きたい課題、提案内容、表示・導線・CMS・多言語への影響。 -- コンテンツ・CMS・多言語: 対象コンテンツ、対象ロケール、CMS 編集可否、公開日時、内部リンク、CTA、Pagefind への影響。 -- 運用・デプロイ: 対象環境、実施内容、必要権限、外部サービス、ロールバック、公開後確認。 - -## 運用ルール - -- Issue title は template の prefix を残し、本文で具体化します。 -- `完了条件` は、PR の確認項目や `Closes #番号` の判断材料になるように書きます。 -- 迷った場合は、最も近い template を使い、`補足` に迷った理由を書きます。 -- 新しい template を増やす前に、既存 template の個別項目で表現できないかを確認します。 -- Template を追加・変更した場合は、`AGENTS.md` と `.github/copilot-instructions.md` の運用説明も必要に応じて更新します。 +迷った場合は `タスク` を使い、足りない情報はコメントで補います。新しい template は、既存の 2 種類では明確に扱えない場合だけ追加します。 diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index cb690e1..82e38b3 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,12 +1,7 @@ -name: 不具合報告 -description: 表示崩れ、動作不良、ビルド失敗など、期待どおりに動かない問題 +name: 不具合 +description: 表示崩れ、動作不良、ビルド失敗など title: '[不具合] ' body: - - type: markdown - attributes: - value: | - 共通項目は他の issue template と同じ順序です。再現に必要な情報は、個別項目に具体的に書いてください。 - - type: textarea id: summary attributes: @@ -18,65 +13,7 @@ body: required: true - type: textarea - id: background - attributes: - label: 背景・目的 - description: どの利用者や運用に影響するかを書いてください。 - placeholder: | - 例: スマートフォンから料金を確認する利用者が CTA を押しにくい。 - validations: - required: true - - - type: textarea - id: acceptance - attributes: - label: 完了条件 - description: レビュー時に完了判断できるチェックリストを書いてください。 - placeholder: | - - [ ] モバイル幅でカードが重ならない - - [ ] デスクトップ幅の表示が崩れない - - [ ] 対象ページのビルドが通る - validations: - required: true - - - type: textarea - id: scope - attributes: - label: 対象範囲・除外範囲 - description: 今回触る範囲と、触らない範囲を分けて書いてください。 - placeholder: | - 対象: - - /pricing/ の料金カード - - 除外: - - 料金文言の変更 - validations: - required: true - - - type: textarea - id: related - attributes: - label: 関連パス・URL - description: 画面 URL、リポジトリ内パス、関連 issue/PR、CMS 項目を書いてください。 - placeholder: | - - https://acecore.net/pricing/ - - src/i18n/source/ja/pages/pricing.json - - src/views/PricingPage.astro - - - type: textarea - id: verification - attributes: - label: 確認方法 - description: 実行すべきコマンド、ブラウザ確認、生成物確認を書いてください。 - placeholder: | - - npm run build - - npx prettier --check 対象ファイル - - モバイル幅とデスクトップ幅で表示確認 - validations: - required: true - - - type: textarea - id: current-behavior + id: current attributes: label: 現在の挙動 description: 実際に起きていることを書いてください。 @@ -84,7 +21,7 @@ body: required: true - type: textarea - id: expected-behavior + id: expected attributes: label: 期待する挙動 description: 本来どう動くべきかを書いてください。 @@ -92,28 +29,31 @@ body: required: true - type: textarea - id: reproduction + id: steps attributes: label: 再現手順 - description: 再現できる操作、条件、入力値を書いてください。 + description: 分かる範囲で、再現できる操作や条件を書いてください。 placeholder: | 1. /pricing/ を開く 2. 画面幅を 390px にする 3. 料金カードの CTA 周辺を確認する - - type: dropdown - id: severity + - type: textarea + id: done attributes: - label: 緊急度 - options: - - 通常 - - 高い - - 緊急 + label: 完了条件 + description: 直ったと判断できる状態を書いてください。 + placeholder: | + - [ ] モバイル幅でカードが重ならない + - [ ] 対象ページのビルドが通る validations: required: true - type: textarea - id: notes + id: context attributes: - label: 補足 - description: 権限、期限、制約、依存関係などがあれば書いてください。 + label: 関連情報 + description: URL、スクリーンショット、関連ファイル、補足があれば書いてください。 + placeholder: | + - URL: + - 関連ファイル: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 97e6d3a..3f52241 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: false +blank_issues_enabled: true contact_links: - name: 事業・Webサイトに関する問い合わせ url: https://acecore.net/contact/ diff --git a/.github/ISSUE_TEMPLATE/content-cms-i18n.yml b/.github/ISSUE_TEMPLATE/content-cms-i18n.yml deleted file mode 100644 index 79898ee..0000000 --- a/.github/ISSUE_TEMPLATE/content-cms-i18n.yml +++ /dev/null @@ -1,140 +0,0 @@ -name: コンテンツ・CMS・多言語 -description: ブログ、ニュース、固定ページ文言、CMS 項目、翻訳の追加・更新 -title: '[コンテンツ] ' -body: - - type: markdown - attributes: - value: | - 日本語ソース、CMS 設定、翻訳、内部リンク、Pagefind への影響を分けて書いてください。 - - - type: textarea - id: summary - attributes: - label: 概要 - description: 何を追加・変更したいかを 1-3 行で書いてください。 - placeholder: | - 例: Sveltia CMS の運用手順をブログ記事として追加する。 - validations: - required: true - - - type: textarea - id: background - attributes: - label: 背景・目的 - description: なぜ必要か、誰に影響するかを書いてください。 - placeholder: | - 例: CMS 移行後の編集フローを社内外に説明できる状態にしたい。 - validations: - required: true - - - type: textarea - id: acceptance - attributes: - label: 完了条件 - description: レビュー時に完了判断できるチェックリストを書いてください。 - placeholder: | - - [ ] 日本語ソース記事が追加されている - - [ ] 必要なタグと関連記事が設定されている - - [ ] 翻訳対象または翻訳不要の判断が明記されている - - [ ] Pagefind や sitemap への影響を確認している - validations: - required: true - - - type: textarea - id: scope - attributes: - label: 対象範囲・除外範囲 - description: 今回触る範囲と、触らない範囲を分けて書いてください。 - placeholder: | - 対象: - - src/content/blog/*.md - - src/content/tags/*.json - - 除外: - - 既存記事の全面リライト - validations: - required: true - - - type: textarea - id: related - attributes: - label: 関連パス・URL - description: 画面 URL、リポジトリ内パス、関連 issue/PR、CMS 項目を書いてください。 - placeholder: | - - src/content/blog/ - - src/i18n/source/ja/ - - public/admin/config.yml - - - type: textarea - id: verification - attributes: - label: 確認方法 - description: 実行すべきコマンド、ブラウザ確認、生成物確認を書いてください。 - placeholder: | - - npm run build - - npx prettier --check 対象ファイル - - dist/sitemap-0.xml または対象ページの HTML を確認する - validations: - required: true - - - type: dropdown - id: content-kind - attributes: - label: 種別 - options: - - ブログ・ニュース - - 固定ページ文言 - - CMS 設定 - - 著者・タグ - - 翻訳のみ - validations: - required: true - - - type: textarea - id: locales - attributes: - label: 対象ロケール - description: 対象言語と、日本語ソースを変更するかどうかを書いてください。 - placeholder: | - - 日本語ソース: 変更する - - 翻訳: en, zh-cn, es, pt, fr, ko, de, ru - validations: - required: true - - - type: textarea - id: cms-fields - attributes: - label: CMS 編集可否・項目 - description: CMS から編集可能にする必要がある項目を書いてください。 - placeholder: | - - CMS から編集可能にする: - - public/admin/config.yml の更新: - - - type: textarea - id: publication - attributes: - label: 公開日時・表示期間 - description: 公開日時、表示開始、表示終了、キャンペーン期間などを書いてください。 - placeholder: | - - 公開日時: - - 表示開始: - - 表示終了: - - - type: textarea - id: seo-links - attributes: - label: 内部リンク・CTA・検索への影響 - description: 関連記事、タグ、CTA、Pagefind、sitemap への影響を書いてください。 - placeholder: | - - 関連記事: - - タグ: - - CTA: - - Pagefind/sitemap: - validations: - required: true - - - type: textarea - id: notes - attributes: - label: 補足 - description: 権限、期限、制約、依存関係などがあれば書いてください。 diff --git a/.github/ISSUE_TEMPLATE/operations.yml b/.github/ISSUE_TEMPLATE/operations.yml deleted file mode 100644 index 3b3ca32..0000000 --- a/.github/ISSUE_TEMPLATE/operations.yml +++ /dev/null @@ -1,124 +0,0 @@ -name: 運用・デプロイ -description: Cloudflare Pages、DNS、CMS 認証、GitHub Actions、公開後確認などの運用作業 -title: '[運用] ' -body: - - type: markdown - attributes: - value: | - 外部サービスや権限が関わる作業は、実施対象、必要権限、確認方法、ロールバックを明確にしてください。 - - - type: textarea - id: summary - attributes: - label: 概要 - description: 何を実施したいかを 1-3 行で書いてください。 - placeholder: | - 例: schools.acecore.net の Cloudflare Pages カスタムドメインを公開状態にする。 - validations: - required: true - - - type: textarea - id: background - attributes: - label: 背景・目的 - description: なぜ必要か、誰に影響するかを書いてください。 - placeholder: | - 例: Pages のデプロイは完了しているが、DNS 設定が未完了で公開 URL が利用できない。 - validations: - required: true - - - type: textarea - id: acceptance - attributes: - label: 完了条件 - description: レビュー時に完了判断できるチェックリストを書いてください。 - placeholder: | - - [ ] 対象ドメインが正しい Pages project に向いている - - [ ] Cloudflare 側のカスタムドメイン状態が Active になっている - - [ ] 公開 URL に 200 でアクセスできる - - [ ] 権限不足がある場合は必要 permission と未完了状態を記録している - validations: - required: true - - - type: textarea - id: scope - attributes: - label: 対象範囲・除外範囲 - description: 今回触る範囲と、触らない範囲を分けて書いてください。 - placeholder: | - 対象: - - Cloudflare Pages custom domain - - DNS CNAME - - 除外: - - サイト本文の変更 - validations: - required: true - - - type: textarea - id: related - attributes: - label: 関連パス・URL - description: 画面 URL、リポジトリ内パス、関連 issue/PR、CMS 項目を書いてください。 - placeholder: | - - https://schools.acecore.net/ - - Cloudflare Pages project: - - .github/workflows/ - - - type: textarea - id: verification - attributes: - label: 確認方法 - description: 実行すべきコマンド、ブラウザ確認、外部サービス確認を書いてください。 - placeholder: | - - wrangler pages deployment list - - DNS record の状態確認 - - 公開 URL の HTTP status 確認 - validations: - required: true - - - type: dropdown - id: environment - attributes: - label: 対象環境 - options: - - 本番 - - プレビュー - - ローカル - - GitHub Actions - - Cloudflare - validations: - required: true - - - type: textarea - id: operation-details - attributes: - label: 実施内容 - description: 実行する操作、設定変更、確認したい状態を書いてください。 - validations: - required: true - - - type: textarea - id: permissions - attributes: - label: 必要権限・外部サービス - description: 必要な権限、secret、token、外部サービス、未確認のアクセス権を書いてください。secret の値は書かないでください。 - placeholder: | - - Cloudflare Account: - - 必要 permission: - - GitHub secret: - - - type: textarea - id: rollback - attributes: - label: ロールバック・復旧方針 - description: 問題が起きた場合に戻す設定や停止条件を書いてください。 - placeholder: | - - 変更前の DNS record: - - 失敗時の戻し方: - - - type: textarea - id: notes - attributes: - label: 補足 - description: 権限、期限、制約、依存関係などがあれば書いてください。 diff --git a/.github/ISSUE_TEMPLATE/site-change.yml b/.github/ISSUE_TEMPLATE/site-change.yml deleted file mode 100644 index f5e915e..0000000 --- a/.github/ISSUE_TEMPLATE/site-change.yml +++ /dev/null @@ -1,109 +0,0 @@ -name: サイト改善・機能追加 -description: 固定ページ、UI、導線、フォーム、コンポーネントなどの改善 -title: '[改善] ' -body: - - type: markdown - attributes: - value: | - 共通項目は他の issue template と同じ順序です。実装の自由度を残す場合も、完了条件は具体的にしてください。 - - - type: textarea - id: summary - attributes: - label: 概要 - description: 何をしたいかを 1-3 行で書いてください。 - placeholder: | - 例: サービス詳細から問い合わせまでの導線を分かりやすくする。 - validations: - required: true - - - type: textarea - id: background - attributes: - label: 背景・目的 - description: なぜ必要か、誰に影響するかを書いてください。 - placeholder: | - 例: サービスページ閲覧後に次の行動が分かりにくい。 - validations: - required: true - - - type: textarea - id: acceptance - attributes: - label: 完了条件 - description: レビュー時に完了判断できるチェックリストを書いてください。 - placeholder: | - - [ ] 対象ページに自然な CTA が追加されている - - [ ] 既存の多言語 fallback が崩れていない - - [ ] CMS で編集すべき文言は CMS 設定に反映されている - validations: - required: true - - - type: textarea - id: scope - attributes: - label: 対象範囲・除外範囲 - description: 今回触る範囲と、触らない範囲を分けて書いてください。 - placeholder: | - 対象: - - /services/ の CTA - - 除外: - - 新しいサービスカテゴリの追加 - validations: - required: true - - - type: textarea - id: related - attributes: - label: 関連パス・URL - description: 画面 URL、リポジトリ内パス、関連 issue/PR、CMS 項目を書いてください。 - placeholder: | - - https://acecore.net/services/ - - src/i18n/source/ja/pages/services.json - - public/admin/config.yml - - - type: textarea - id: verification - attributes: - label: 確認方法 - description: 実行すべきコマンド、ブラウザ確認、生成物確認を書いてください。 - placeholder: | - - npm run build - - npx prettier --check 対象ファイル - - デスクトップ幅とモバイル幅で対象ページを確認する - validations: - required: true - - - type: textarea - id: problem - attributes: - label: 解きたい課題 - description: 現状のどこが不十分かを書いてください。 - validations: - required: true - - - type: textarea - id: proposal - attributes: - label: 提案内容 - description: 具体案があれば書いてください。実装方法を固定しない場合は、その旨を書いてください。 - - - type: textarea - id: impact - attributes: - label: 表示・導線・CMS・多言語への影響 - description: UI、翻訳、CMS 設定、内部リンク、フォーム送信などへの影響を書いてください。 - placeholder: | - - 表示: - - CMS: - - 多言語: - - 導線: - validations: - required: true - - - type: textarea - id: notes - attributes: - label: 補足 - description: 権限、期限、制約、依存関係などがあれば書いてください。 diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 0000000..34394ea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -0,0 +1,35 @@ +name: タスク +description: 改善、コンテンツ、CMS、運用などの作業依頼 +title: '[タスク] ' +body: + - type: textarea + id: summary + attributes: + label: 概要 + description: 何をしたいか、または何を変えたいかを 1-3 行で書いてください。 + placeholder: | + 例: トップページの導線文言を CMS から編集できるようにする。 + validations: + required: true + + - type: textarea + id: done + attributes: + label: 完了条件 + description: 完了と判断できる状態をチェックリストで書いてください。 + placeholder: | + - [ ] 対象文言が CMS から編集できる + - [ ] 既存表示が崩れない + - [ ] 必要な検証が通る + validations: + required: true + + - type: textarea + id: context + attributes: + label: 関連情報 + description: URL、関連ファイル、期限、制約、背景があれば書いてください。 + placeholder: | + - URL: + - 関連ファイル: + - 補足: diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 586444b..ec29bae 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -3,9 +3,10 @@ 変更前に `AGENTS.md` を確認してください。要点は次の通りです。 - GitHub 上のユーザー向け文章は、明示がない限り日本語で書く。 -- PR タイトルと本文は日本語にし、`.github/pull_request_template.md` に沿って書く。 +- PR タイトルと本文は日本語にし、関連 Issue、概要、確認、補足を簡潔に書く。 - Issue URL が渡された場合は、本文とチェックリストを受け入れ条件として扱う。 -- Issue template の共通項目と個別項目は `.github/ISSUE_TEMPLATE/README.md` を正とする。 +- Issue template は `不具合` と `タスク` を基本にし、必要以上に入力項目を増やさない。 - 多言語対応では日本語ソースを正とし、CMS と翻訳構成を崩さない。 +- CMS 認証は GitHub 認証型とし、Cloudflare Access は必要に応じて入口保護として扱う。 - 差分は目的に必要な範囲に絞り、既存の Astro、TypeScript、UnoCSS 構成を尊重する。 - サイト出力に影響する変更では `npm run build` を実行する。docs/template のみなら対象ファイルの format check と `git diff --check` を行う。 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index adba7c1..a266e5b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,29 +1,13 @@ -## 関連 Issue - - - -なし +関連 Issue: なし ## 概要 - - -- - -## 主な変更点 - - - - -## 確認したこと - - +## 確認 - -## 未確認事項・補足 - - +## 補足 なし diff --git a/AGENTS.md b/AGENTS.md index 53be6e2..b8eab59 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -14,9 +14,8 @@ ## Issue 対応 - Issue URL だけを渡された場合でも、issue 本文、コメント、チェックリストを確認して受け入れ条件として扱う。 -- Issue template の設計と分類は `.github/ISSUE_TEMPLATE/README.md` を正とし、共通項目と個別項目を混ぜて増やさない。 -- Issue には原則として、概要、背景・目的、完了条件、対象範囲・除外範囲、関連パス・URL、確認方法を含める。 -- 新しい issue template を追加する場合は、共通項目の順序と見出しを既存 template と揃え、個別項目はその種別でしか判断できない情報に絞る。 +- Issue template は `不具合` と `タスク` を基本にし、概要、完了条件、関連情報だけで着手判断できる簡潔な入力にする。 +- 新しい issue template を追加する前に、既存の `タスク` で表現できないか確認する。 - 実装前に既存の構成、同種コンポーネント、翻訳データ、CMS 設定、関連コンテンツを確認し、既存パターンに合わせる。 - 要件が曖昧でも、リポジトリ内の文脈から安全に判断できる場合は作業を進める。判断が危険な場合だけ質問する。 - Issue 対応 PR では、PR 本文の「関連 Issue」に `Closes #番号` または該当 issue への参照を残す。 @@ -27,6 +26,8 @@ - 翻訳ファイルは `src/i18n/translations/{locale}.json` に集約されている。日本語 source のキー構造と翻訳側のキー構造を揃える。 - サイト文言を CMS から編集可能にする場合は `public/admin/config.yml` も更新し、対応する JSON key とフィールド名を揃える。 - CMS の日時、キャンペーン、告知、募集枠など期間制御が必要な情報は、表示開始と表示終了を CMS から扱える設計にする。 +- このリポジトリの CMS 認証は GitHub 認証型とする。Cloudflare Access を前段に置く場合も、保存認証は GitHub OAuth Worker を使う。 +- Cherry のような Cloudflare Access 型 proxy へ寄せる場合は、別途 backend actor、書き込み path 制限、CI 経由 PR 作成まで設計してから行う。 - CMS backend の publication branch は `main` にし、`publish_mode: editorial_workflow` で短命な CMS branch と PR を作らせる。 - `cms-content` のような恒久的な CMS 投稿受け皿 branch は使わない。 - CMS PR は merge commit または rebase merge で `main` に入れる。squash merge では `cms: ...` commit subject が失われ、翻訳 PR task の自動検出対象外になる場合がある。 @@ -44,6 +45,6 @@ ## PR 作成 -- PR タイトルと本文は日本語で書き、`.github/pull_request_template.md` に沿って概要、主な変更点、確認したこと、未確認事項・補足を含める。 +- PR タイトルと本文は日本語で書き、`.github/pull_request_template.md` に沿って関連 Issue、概要、確認、補足を簡潔に書く。 - PR は draft で作成してよい。ユーザーが ready を求めた場合、または自動化タスクが ready for review を明示している場合だけ ready にする。 - 実行したコマンドは省略せず書く。実行していない検証は「未実施」と明記する。 diff --git a/README.md b/README.md index 9b508af..b3f5518 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ src/ ### Sveltia CMS(推奨) 1. 本番では `https://acecore.net/admin/index.html`、ローカルでは `http://localhost:4321/admin/index.html` にアクセス -2. 本番編集は GitHub OAuth でサインインする +2. 本番編集は GitHub OAuth でサインインする。このリポジトリは GitHub 認証型で、Cloudflare Access を使う場合も前段の入口保護に限定する 3. ローカル確認では `Work with Local Repository` を選び、repo root を指定する 4. 「ブログ」から日本語ソース記事のみ新規作成・編集 5. 「ページ・サイト文言」からナビ、フッター、SEO、固定ページの日本語テキストをページ/用途別に編集 diff --git a/docs/cms-write-workflow.md b/docs/cms-write-workflow.md index be26b96..6e05b7f 100644 --- a/docs/cms-write-workflow.md +++ b/docs/cms-write-workflow.md @@ -7,6 +7,7 @@ - GitHub repository: `acecore-systems/acecore-net` - GitHub default branch: `main` - CMS backend: `public/admin/config.yml` の `backend.name: github` +- CMS auth mode: GitHub 認証型 - CMS OAuth backend: `https://sveltia-cms-auth.sparkling-tree-7cef.workers.dev` - CMS publication branch: `main` - CMS publish mode: `editorial_workflow` @@ -20,6 +21,8 @@ Sveltia CMS は `backend.branch: main` と `publish_mode: editorial_workflow` で運用します。CMS 保存は恒久的な投稿受け皿 branch ではなく、短命な `cms/...` branch と PR として扱います。 +Cloudflare Access を `/admin/` の前段に置く場合も、保存認証は GitHub OAuth Worker が担当します。Cherry のような Cloudflare Access 型 token proxy には寄せません。 + `cms-content` は恒久運用しません。旧 remote branch は未反映差分や open PR がないことを確認して削除済みです。 ## 現行フロー