[docs-scanner] Unclear policy change timing in organization policies overview

オープン 初心者向け
  • 何か問題がありますか？
#26,555 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1〜3時間
初心者へのやさしさ
89/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
markdown
領域
documentation

調査の方向性

Issue では content/manuals/ai/governance/organization/policies/_index.md と、リンク先の network.md、filesystem.md、mcp.md が挙げられています。タイミングの説明を確認するため、概要セクションと3つの「When changes take effect」セクションを読みます。同期には最大5分かかり、ポリシーの種類によって評価のタイミングが決まることが明確になるよう、概要を更新します。追加の遅延があると受け取れる表現がなくなれば完了です。

索引モデルが issue の本文から書いたものです。

説明

File: content/manuals/ai/governance/organization/policies/_index.md

Issue

The "When policy changes reach developers" section creates confusion about timing by stating:

Policy changes reach developer machines within 5 minutes. When a synced change takes effect also depends on the policy type.

This phrasing suggests there are two separate delays: (1) a 5-minute sync delay, and (2) an additional type-specific delay after syncing. However, the individual policy pages all describe immediate effect after the sync completes:

  • network.md: "Once a policy change has synced to the developer's machine, it applies immediately to subsequent requests."
  • filesystem.md: "Once a policy change has synced to the developer's machine, it applies the next time a sandbox starts."
  • mcp.md: "Once a policy change has synced to the developer's machine, use-time rules apply to subsequent governed MCP requests."
Why this matters

Readers trying to understand when their policy changes will take effect are left uncertain whether there's a 5-minute delay plus additional waiting, or just the 5-minute sync delay. The phrase "When a synced change takes effect also depends on the policy type" implies additional delays beyond syncing, but the linked pages describe only the sync delay.

Suggested fix

Clarify that the 5-minute sync is the only delay, and that "when it takes effect" refers to the evaluation point (per-request vs. sandbox start), not an additional delay. For example:

Policy changes reach developer machines within 5 minutes. Once synced, when the change applies depends on the policy type: network and MCP policies apply to subsequent requests, while filesystem policies apply when a sandbox starts.

Or link directly to the specific sections without the ambiguous "also depends" phrasing:

Policy changes reach developer machines within 5 minutes. For when changes apply after syncing, see Organization network access policies, Organization filesystem access policies, and Organization MCP access policies.

Found by nightly documentation quality scanner

主要言語
Markdown
スター
4.7k
フォーク
8.5k
平均マージ
2日 19時間
マージ済み PR（30日）
156

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

docker/docs のほかの issue

docker/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。