Automate upstream schema sync with docs
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ó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 52/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Lĩnh vực
- documentation, tooling
Hướng nghiên cứu
Xem lại các PR 178 và 179 đã hoàn tất, sau đó kiểm tra schema upstream hiện tại và cấu trúc tài liệu. Thêm các bước kiểm tra độ bao phủ để đánh dấu các policy trong schema không có tài liệu tương ứng và các policy đã được tài liệu hóa nhưng không có mục nhập trong schema; hoàn thành khi cả hai hướng không khớp đều được báo cáo rõ ràng.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Background:
Right now, updates here are still mostly manual, which means docs tend to drift from (Firefox) code. We have the opportunity to sync with upstream definitions, so to make things a little more stable, I'm going to make the following changes:
Tasks:
- https://github.com/mozilla/enterprise-admin-reference/pull/178
- https://github.com/mozilla/enterprise-admin-reference/pull/179
- Add some checks for docs coverage against the schema
Motivation:
-
At minimum, we should flag policies that exist in schema that do not have matching docs pages, and the inverse is also detectable, although rare.
-
Longer term, the schema should drive generated reference elements on docs pages: policy description, defaults, compatibility, examples. The goal would be to have hand-written docs focus on explanation & context, gotchas etc. while the reference details come from upstream.
- Ngôn ngữ chính
- MDX
- Star
- 12
- Fork
- 17
- Merge trung bình
- 8 giờ 42 phút
- Pull request đã merge (30 ngày)
- 38
Chuẩn bị môi trường
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 mozilla/enterprise-admin-reference
-
Remove compat info from proseĐang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 55/100
mozilla/enterprise-admin-reference#339 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Missing details about AutoConfigĐang mởdocumentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 45/100
mozilla/enterprise-admin-reference#292 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Missing identity / certs guideĐang mởdocumentation
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
mozilla/enterprise-admin-reference#291 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
mozilla/enterprise-admin-reference#290 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
mozilla/enterprise-admin-reference#289 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của mozilla/enterprise-admin-reference
Issue tương tự
-
area:breg criticality:p3 documentation triage:needs-implementation
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 86/100
registrystack/registry-stack#1713 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Rename CLAUDE.md to AGENTS.mdĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
posit-dev/ggsql#565 · 1 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation easy good first issue help wanted
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
lacs-project/sysknife#518 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
qgis/QGIS-Plugins-Website#459 ·
-
bot-found documentation priority: P3
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
madenvel/KalinkaPlayer#178 ·