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

Aperta Adatta ai principianti
  • Qualcosa non va?
#26,555 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
89/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

L’issue indica content/manuals/ai/governance/organization/policies/_index.md e le pagine collegate network.md, filesystem.md e mcp.md. Leggi la sezione introduttiva insieme alle tre sezioni «When changes take effect» per verificare le descrizioni delle tempistiche. Aggiorna la sezione introduttiva per chiarire che la sincronizzazione richiede fino a cinque minuti e che il tipo di policy determina il momento della valutazione; il lavoro è completato quando non lascia più intendere che ci sia un ritardo aggiuntivo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Markdown
Stelle
4.7k
Fork
8.5k
Merge medio
2g 19h
PR unite (30g)
156

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di docker/docs

Tutte le issue di docker/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.