[docs-scanner] Inconsistent terminology: 'nested organization' vs 'organization in the company'
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
- Dưới một giờ
- Mức phù hợp với người mới
- 88/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
- Lĩnh vực
- documentation
Hướng nghiên cứu
Mở content/manuals/accounts/company/manage.md và xem lại đoạn được trích dẫn trong issue. Thay “nested organization” bằng cách diễn đạt nhất quán như “organization in the company”, đồng thời giữ nguyên các chi tiết về gói đăng ký và việc quản lý. Hoàn thành khi thuật ngữ khớp với tài liệu công ty xung quanh.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
File: content/manuals/accounts/company/manage.md
Issue
The manage.md page introduces the term "nested organization" without defining it, while the rest of the documentation consistently uses "organization in the company" or "organizations within the company":
A nested organization must keep its Docker Business subscription to stay managed by the company. If an organization downgrades from Docker Business, you can no longer manage it through the company, and its owner must manage it separately.
The term "nested organization" does not appear in:
- The company overview page (_index.md)
- The company creation page (new-company.md)
- Any other section of manage.md
Why this matters
Readers encountering "nested organization" for the first time in this context may wonder if it refers to a special type of organization or configuration. The inconsistent terminology creates unnecessary cognitive load when the concept is straightforward: organizations that belong to a company.
Suggested fix
Replace "nested organization" with "organization" or "organization in the company" to match the terminology used throughout the rest of the documentation:
An organization in the company must keep its Docker Business subscription to stay managed by the company. If an organization downgrades from Docker Business, you can no longer manage it through the company, and its owner must manage it separately.
Or more concisely:
Organizations must keep their Docker Business subscription to stay managed by the company. If an organization downgrades from Docker Business, you can no longer manage it through the company, and its owner must manage it separately.
Found by nightly documentation quality scanner
- Ngôn ngữ chính
- Markdown
- Star
- 4.7k
- Fork
- 8.5k
- Merge trung bình
- 1 ngày 22 giờ
- Pull request đã merge (30 ngày)
- 148
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của docker/docs
-
status/triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
docker/docs#26484 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
Maintainer thường phản hồi trong vòng 1 ngày
-
[docs-scanner] SSO overview omits OAT as CLI authentication optionCó thể đã có người làm @dave123981 đã nhận 2 ngày trước. Đang mở
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 92/100
Maintainer thường phản hồi trong vòng 1 ngày
-
status/triage
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 1 ngày
Issue tương tự
-
bug documentation
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
awslabs/visual-asset-management-system#880 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
netbox status: needs owner type: documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
netbox-community/netbox#23533 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
app: scripts status: backlog type: documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
netbox-community/netbox-scripts#68 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 91/100
marin-community/marin#10765 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
rfordatascience/tidytuesday#1098 ·