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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#26,555 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
89/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Issue chỉ ra content/manuals/ai/governance/organization/policies/_index.md và các trang được liên kết network.md, filesystem.md, mcp.md. Đọc phần tổng quan cùng ba phần “When changes take effect” để xác minh mô tả về thời điểm. Cập nhật phần tổng quan để làm rõ rằng việc đồng bộ mất tối đa năm phút và loại chính sách quyết định thời điểm đánh giá; hoàn tất khi nội dung không còn ngụ ý có thêm độ trễ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Markdown
Star
4.7k
Fork
8.5k
Merge trung bình
2 ngày 19 giờ
Pull request đã merge (30 ngày)
156

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của docker/docs

Tất cả issue của docker/docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.