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

未关闭
#2,757 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
62/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
github-actions, markdown, yaml

调研方向

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/.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Rust
星标
2
派生
0
平均合并
9 小时 48 分钟
30 天内合并 PR
151

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

registrystack/registry-stack 的其他 Issue

查看 registrystack/registry-stack 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。