fix: add missing lint config files referenced by npm scripts - #111
Queued
mrbobbytables wants to merge 1 commit into
Queued
mrbobbytables wants to merge 1 commit into
mrbobbytables wants to merge 1 commit into
Conversation
npm run check:spelling, check:markdown, and check:links-md all reference config files (.cspell.yml, .markdownlint.yaml, .markdown-link-check.json) that do not exist in the repository, so every contributor who runs these scripts locally hits a hard "Config file not accessible" error instead of getting real lint/spelling feedback. - Add .cspell.yml with CNCF/project-specific technical terms and contributor names so check:spelling passes cleanly. - Add .markdownlint.yaml, relaxing line-length (MD013), single-H1 (MD025), and inline-HTML (MD033) rules that don't fit this Docusaurus site's prose and MDX/React component usage. - Add .markdown-link-check.json with sane timeout/retry defaults for check:links-md. Found via advisory analysis for issue cncf#24. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
![kubestellar-hive[bot]](https://avatars.githubusercontent.com/in/3568013?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Approved by @castrojo for Hive auto-merge on green CI.
kubestellar-hive
Bot
added
the
lgtm
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Advisory finding (issue #24)
While reviewing this repo as part of the Hive advisory process, I found that
three npm scripts reference lint/config files that do not exist anywhere in
the repository, so anyone running them locally (or in future CI) gets a hard
config error instead of real feedback:
npm run check:spelling->cspell -c .cspell.yml ...(.cspell.ymlmissing)npm run check:markdown->markdownlint -c .markdownlint.yaml ...(.markdownlint.yamlmissing)npm run _check:links-md->markdown-link-check --config .markdown-link-check.json ...(.markdown-link-check.jsonmissing)None of these are currently wired into CI, so this hasn't broken any builds,
but it's a dead-end for contributors trying to use the documented
npm run checkworkflow.Changes
.cspell.ymlwith a word list covering CNCF/project terminology,architecture-doc jargon (Kyverno, Kubevirt, Dapr, etc.), and contributor
names that appear in the docs, so
npm run check:spellingpasses cleanly..markdownlint.yaml, relaxing:MD013(line length) — prose here isn't hard-wrapped at 80 chars.MD025(single H1) — Docusaurus pages get their H1 from frontmattertitle.MD033(inline HTML) — pages intentionally embed raw HTML andMDX/React components (
<CommunityPeople />,<AwardsTimeline />, etc.)..markdown-link-check.jsonwith reasonable timeout/retry defaults.Verified
npm run check:markdownnow runs against the new config instead oferroring, though it still surfaces a number of pre-existing content issues
(missing alt text, heading spacing, etc.) in the imported architecture docs
under
docs/architectures/— those are content fixes and out of scope here,noted separately as a follow-up advisory item.
Note:
npm run check:links(themake check-links/ htmltest-basedtarget) still has no
Makefilein the repo, so it remains broken; fixingthat involves adding htmltest tooling and is a larger, separate task.
Relates to #24.