Skip to content

docs: 経緯と重複を削って短くする - #446

Merged
5ym merged 1 commit into
mainfrom
trim-docs
Oct 18, 2026
Merged

5ym merged 1 commit into
mainfrom
trim-docs

Conversation

@5ym

@5ym 5ym commented Oct 18, 2026

Copy link
Copy Markdown
Collaborator

docs と README から、運用に要らなくなった文を削りました(21 ファイル、+154 / −278 行。差し引き 124 行減)。

削ったもの

  • 経緯の話: 日付つきの「〜した」、移行の話(k3s / Ubuntu の頃、Zulip・Mattermost・wg-easy・Headscale・Traefik・Portainer・ERPNext・MeshCentral との比較)、見出しの日付。再発しうる罠は 1 行で残した(bond0 の MAC は固定しないと変わる、hookshot の App を消して設定を残すと起動しない、など)
  • 重複: 2 か所で同じ説明をしているものは片方を短いリンクにした
    • 公開経路の置き場(decisions ↔ bootstrap/README)
    • DNS の方針(decisions ↔ apps/external-dns)
    • fj.doany.io の取得(talos/README ↔ apps/forgejo)
    • bootstrap が鶏と卵にならない理由(decisions ↔ bootstrap/README)
    • LoadBalancer とクライアント IP(decisions ↔ docs/talos.md)
    • infisical の描き出しに秘密が入る理由(decisions の中で 2 回)
  • 終わった作業の記録: ExternalDNS の移行表、pulumi/README の「経緯」、k8up の retired タグの話、forgejo の初回だけの手順、ROADMAP の「済んだこと」(2 行にした)、ghcr の pull 認証の節(talos/README と同じ内容)
  • docs/entra.md の wg-easy のアプリ登録の行(Entra に既に無い)

直したもの

  • apps/forgejo/README.md: リダイレクト URI を「az ad app update で追加済み」から pulumi/entra.ts を指す形に

変えていないもの

手順(recovery、当て直し、Z440 への移行)、表、罠の注意書き。コードのコメントから参照されている見出しの文言(「PT3 チューナー」「VPN を wg-easy から NetBird にした」「DANE への切り替え」など)はそのまま残した。日付を外したのは見出しの後ろの括弧だけ。

🤖 Generated with Claude Code

https://claude.ai/code/session_01JbmWyUB9jcBcYCnNyiGBSV

- 日付つきの経緯・移行の話(k3s / Ubuntu の頃、Zulip・wg-easy・Traefik・Portainer など)を削った。
  再発しうる罠だけ 1 行で残した
- 同じ説明が 2 か所にあるものは片方を短いリンクにした(公開経路、DNS の方針、fj.doany.io の取得、bootstrap の層の分け方など)
- 終わった作業の記録(ExternalDNS の移行表、pulumi の経緯、k8up の retired タグ、ROADMAP の済んだこと)を圧縮・削除
- docs/entra.md の wg-easy のアプリ登録の行を削除(Entra に既に無い)
- forgejo の README のリダイレクト URI を pulumi/entra.ts を指す形に直した

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JbmWyUB9jcBcYCnNyiGBSV
@claude

claude Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Claude finished @5ym's task in 26s —— View job


レビュー結果

docs だけの変更なので、コードの不具合・セキュリティ・テストに当たる指摘はありません。リンク切れが出ていないかを重点的に見ました。

  • 見出しの参照: コードのコメントや他の docs が使う「」の見出し(PT3 チューナー、ルーティングの選定、LoadBalancer をどう置き換えるか、infisical だけは ArgoCD に移せない、DNS:直接つなぐアプリと…、VPN を wg-easy から NetBird にした、層の分け方、手で持つもの、ツール選定(比較の結論) など)は、すべて docs/decisions.md に残っています。日付を外したのは括弧の部分だけで、参照とは食い違っていません。
  • .md# 形式のアンカー参照: リポジトリ内に見つかりませんでした。アンカーが切れる心配はありません。
  • 削った見出し: 「ghcr の pull 認証」「移した記録」「経緯」を参照している箇所は、リポジトリ内に見つかりませんでした。
  • シークレット: 混入はありません。
  • PR 本文の説明との整合: forgejo の README にあるリダイレクト URI の記述は pulumi/entra.ts を指す形になりました。entra.ts に forgejo の記載があることも確認しました。

要確認(軽微)

  • 各ファイルの本文は、diff が約 105KB と大きく、行ごとには読んでいません。「手順・表・罠の注意書きは変えていない」という点は、見出しと参照の確認までで、本文の突き合わせはしていません。
  • 日付つきのコードコメント(例: bootstrap/cilium/values.yaml の「2026-09-07」)は残っています。これは docs の範囲外なので、指摘ではありません。

問題なく、マージして大丈夫だと思います。

@github-actions

Copy link
Copy Markdown

🍹 preview on doany-cloudflare/prod

Pulumi report
Previewing update (prod):

@ previewing update.....
pulumi:pulumi:Stack doany-cloudflare-prod  
Resources:
54 unchanged

@5ym
5ym merged commit 1be3c71 into main Oct 18, 2026
6 checks passed
@5ym
5ym deleted the trim-docs branch October 18, 2026 06:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant