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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#26,555 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
89/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
markdown
Área
documentation

Línea de trabajo

El issue identifica content/manuals/ai/governance/organization/policies/_index.md y las páginas enlazadas network.md, filesystem.md y mcp.md. Lee la sección de descripción general junto con las tres secciones «When changes take effect» para verificar las descripciones de los plazos. Actualiza la descripción general para aclarar que la sincronización tarda hasta cinco minutos y que el tipo de política determina el momento de la evaluación; el trabajo estará terminado cuando ya no dé a entender que hay una demora adicional.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Markdown
Estrellas
4.7k
Forks
8.5k
Merge medio
2 d 19 h
PR fusionados (30 d)
156

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de docker/docs

Todos los issues de docker/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.