Lint the deploy guides (deploy/**/*.md) with the docs-site Vale and markdownlint rules

Đang mở
#2,757 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
62/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ệ
github-actions, markdown, yaml
Lĩnh vực
ci-cd, documentation, tooling

Hướng nghiên cứu

Start from check:style in docs/site/package.json and the Vale config beside it (.vale.ini), then find the CI workflow that gates these checks and its path filter to see where deploy/**/*.md must be added. Reproduce locally by running the docs-site Vale config against the seven named files to confirm the 36 BRegFirstUse errors and 30 sentence-length warnings before changing anything. Done looks like CI running Vale and markdownlint over deploy/**/*.md, triggered by changes there, with either the errors fixed or the rule explicitly scoped out for deploy/.

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

Mô tả

area:docs documentation

From the review of #2742.

What happens

The deploy guides under deploy/ (deploy/README.md, deploy/OPERATIONS.md, the chart README, and the identity, intake-status, SeaweedFS and Casework/Evidence example READMEs) are outside every style and Markdown check the docs site has. check:style in docs/site/package.json runs Vale on src/content/docs and the root README only, and markdownlint uses the docs-site scope.

Running the docs-site Vale configuration on those seven files at current main gives 36 RegistryDocs.BRegFirstUse errors and 30 RegistryDocs.SentenceLength warnings. The follow-up PR to #2742 removes most of the sentence-length warnings, but nothing stops them coming back.

Expected

  • Add deploy/**/*.md to the Vale run in CI (and to markdownlint if its rules fit), so changes to these guides get the same checks as the docs site.
  • Fix the BRegFirstUse errors first, or decide that the rule does not apply to operator guides and scope it out for deploy/ in .vale.ini.
  • Make sure the CI change detection that gates these checks also triggers on deploy/**/*.md.

Moving the operator guides onto the docs site would also close this.

Ngôn ngữ chính
Rust
Star
2
Fork
0
Merge trung bình
9 giờ 48 phút
Pull request đã merge (30 ngày)
151

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 registrystack/registry-stack

Tất cả issue của registrystack/registry-stack

Issue tương tự

Thêm issue về Rust

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.