enable: markdown lint + check: links + spelling #308
Conversation
| - code | ||
| - pre | ||
| sources: | ||
| - '**/*.md' |
There was a problem hiding this comment.
We also have html sources if I am not mistaken (e.g. https://github.com/open-component-model/ocm-website/blob/main/layouts/index.html). Would it be possible to check them? Or would the html-syntax be too troublesome.
There was a problem hiding this comment.
I'm not too convinced that the spell checker really makes sense for html pages and propose to keep the check for markdown only.
| ocmcli | ||
| ocmconfig | ||
| oncefunc | ||
| oo |
There was a problem hiding this comment.
i grep -i'd for oo but did not find any occurrence. Are there any?
There was a problem hiding this comment.
I also didn't find any and guess oo can be removed
| preconfigured | ||
| predefine | ||
| programmatically | ||
| prs |
There was a problem hiding this comment.
The occurrences of prs are PRs. Maybe we should just write pull-requests instead of adding prs to the wordlist to prevent any real typo of prs.
There was a problem hiding this comment.
Although there' the chance of misspelling PRs as Pre or pre or any other permutation, I don't want to always write Pull-request instead of PRs and am willing to live with potential "errors" here :-)
content/docs/cli-reference/help/describe_package_toi-bootstrapping.md
Outdated
Show resolved
Hide resolved
| @@ -3,23 +3,20 @@ package main | |||
| import ( | |||
| "bytes" | |||
| "fmt" | |||
| "github.com/spf13/cobra" | |||
There was a problem hiding this comment.
The import-order seems unintended.
| @@ -4,13 +4,12 @@ import ( | |||
| "flag" | |||
| "fmt" | |||
| "log" | |||
| clictx "ocm.software/ocm/api/cli" | |||
There was a problem hiding this comment.
the import-order seems unintended. Probably, an IDE setting or the like
|
although spellchecks and md-lint is still failing, I would really like to merge this ASAP, because now we have NO broken links anymore ;-) after other tasks, I can then maybe pickup the remaining open things in new PRs |
| * [ocm <b>sign</b>](/docs/cli-reference/sign) — Sign components or hashes | ||
| * [ocm <b>transfer</b>](/docs/cli-reference/transfer) — Transfer artifacts or components | ||
| * [ocm <b>verify</b>](/docs/cli-reference/verify) — Verify component version signatures | ||
| * [ocm <b>add</b>](/docs/cli-reference/add/) — Add elements to a component repository or component version |
There was a problem hiding this comment.
Should we indent every line on the same height?
|
@hilmarf, @morri-son, is this PR the reason why hundreds of checks are now failing in #323? Any recommendation? |
yes, Lint Markdown + Spellcheck needs additional attention --> follow up PRs for now, just ignore the failures or feel free to fix some of them ;-) |
|
for the spellchecker I'm still not convinced that we really need it, as it focuses just on words in the dictionary, the rest, especially abbreviations, need to be entered in an exclusions file. For the markdown linter we should carefully check the default checks done and adopt it to our needs. The whole idea of any of the switched on checks in the end should be to add them as mandatory to pass and not to ignore them. |
But less typos are a good thing, right? As we experienced it in the |
sure less typos are a good thing :-) And I'm not in general against a spell checker, but getting blocked by this as the checker brings up issues with "HCM" or "OCM" or "SAP" and forces to update the exclusion file is not really efficient. For sure, most-likely we will have all potential abbreviations and other terms that fit the whole topic maintained, but... |
|
maybe there is a possibility to use the spellchecker as reusable workflow in the In general I would not make the spellchecker as |
|
I also would like to have the spellchecker enabled but not blocking. It is valuable, although it's not perfect... open-component-model/ocm#928 maybe sooner or later some fancy AI github action is more able to also detect syntax and grammar issues. Or can even check that a new abbreviation has been introduced correctly before usage. Currently none of the checks is a blocker. But I highly recommend to set the html-link-check as mandatory. Nothing is more frustrating than not working links, especially when they sound promising with your current problem ;-) |
What this PR does / why we need it:
This better public relation, when all links are working and there are no typing errors.
Which issue(s) this PR fixes:
Some of the issues will be fixed as soon as open-component-model/ocm#871 is merged.