enable: markdown lint + check: links + spelling #308
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| /content/docs/cli-reference | ||
| /content/docs/controller/controller-reference |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| default: true | ||
|
|
||
| MD013: false #Line length - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md013 | ||
| MD033: false #Inline HTML - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md033 | ||
| MD024: | ||
| siblings_only: true #Multiple headers with the same content |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| matrix: | ||
| - name: Markdown | ||
| aspell: | ||
| lang: en | ||
| ignore-case: true | ||
| mode: markdown | ||
| dictionary: | ||
| wordlists: | ||
| - .github/config/wordlist.txt | ||
| encoding: utf-8 | ||
| pipeline: | ||
| - pyspelling.filters.markdown: | ||
| markdown_extensions: | ||
| - pymdownx.superfences | ||
| - pyspelling.filters.html: | ||
| comments: false | ||
| ignores: | ||
| - code | ||
| - pre | ||
| sources: | ||
| - '**/*.md' | ||
| default_encoding: utf-8 | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,290 @@ | ||
| accessmethod | ||
| accessmethoddescriptor | ||
| accessmethods | ||
| actiondescriptor | ||
| additionalresource | ||
| addversion | ||
| adr | ||
| aggregative | ||
| aml | ||
| anchore | ||
| api | ||
| archlinux | ||
| artifactid | ||
| aur | ||
| auth | ||
| autoconfigure | ||
| aws | ||
| backend | ||
| backends | ||
| basename | ||
| bindata | ||
| blobaccess | ||
| blobhandler | ||
| bool | ||
| boolean | ||
| buildx | ||
| cas | ||
| cli | ||
| cliconfig | ||
| clis | ||
| closable | ||
| closeable | ||
| cmds | ||
| cncf | ||
| codeql | ||
| commontransportarchive | ||
| componentaccess | ||
| componentaccessimpl | ||
| componentarchive | ||
| componentreferences | ||
| componentversionaccess | ||
| componentversionaccessimpl | ||
| componentversions | ||
| compvers | ||
| config | ||
| configfile | ||
| configs | ||
| consumerid | ||
| containerd | ||
| crd | ||
| creationtime | ||
| credentialrequest | ||
| credentialsspec | ||
| crossplatform | ||
| crypto | ||
| ctf | ||
| ctfs | ||
| ctx | ||
| cvs | ||
| deepcopy | ||
| defs | ||
| dependabot | ||
| deployscript | ||
| deserializable | ||
| deserialization | ||
| deserialize | ||
| deserialized | ||
| dest | ||
| digesters | ||
| directorytree | ||
| dirtree | ||
| dns | ||
| dockerconfig | ||
| downloadconstraint | ||
| downloader | ||
| downloaderdescriptor | ||
| downloaders | ||
| downloadhandlers | ||
| dry-run | ||
| dup | ||
| dups | ||
| dynaml | ||
| echoserver | ||
| entrypoint | ||
| executables | ||
| executoroptions | ||
| executorspecification | ||
| extensibility | ||
| filepath | ||
| filesystem | ||
| filesytem | ||
| finalizer | ||
| finalizers | ||
| foldername | ||
| forwardspec | ||
| gapped | ||
| gav | ||
| getinexpensivecontentversionidentity | ||
| getresourcesbyname | ||
| getter | ||
| ghcr | ||
| github | ||
| gitignore | ||
| gitops | ||
| globalaccess | ||
| globals | ||
| gocritic | ||
| gofmt | ||
| golang | ||
| golangci | ||
| gomega | ||
| goreleaser | ||
| gosec | ||
| goutils | ||
| groupid | ||
| gzip | ||
| handleoutput | ||
| hashers | ||
| hashicorp | ||
| hashicorpvault | ||
| helmchart | ||
| helmchartrepository | ||
| helmdemo | ||
| helmexecutor | ||
| helminstaller | ||
| helmrepository | ||
| hoc | ||
| homebrew | ||
| hostname | ||
| hostpath | ||
| html | ||
| http | ||
| https | ||
| iaas | ||
| imagemapping | ||
| inlined | ||
| installable | ||
| instantiation | ||
| io | ||
| ioutils | ||
| iterable | ||
| json | ||
| jsonschema | ||
| keyless | ||
| keypair | ||
| keyring | ||
| kubebuilder | ||
| kubeconfig | ||
| kubernetes | ||
| labelmergespecification | ||
| lifecycle | ||
| linter | ||
| linters | ||
| lister | ||
| listers | ||
| localizations | ||
| logconfig | ||
| logrus | ||
| lookups | ||
| macos | ||
| makefile | ||
| makefiles | ||
| mandelsoft | ||
| mapocirepoattr | ||
| matcher | ||
| matchers | ||
| mavenartifact | ||
| mavenpackage | ||
| mavenrepository | ||
| mediatype | ||
| mimetype | ||
| mimetypes | ||
| multiarch | ||
| mutex | ||
| mvn | ||
| mvnrepository | ||
| namespace | ||
| namespaces | ||
| newcomponentaccess | ||
| newcomponentversionaccess | ||
| newrepository | ||
| newrepositoryspec | ||
| npm | ||
| npmjs | ||
| npmrc | ||
| npmregistry | ||
| oauth | ||
| oci | ||
| ociartifact | ||
| ocireg | ||
| ociregistry | ||
| ocm | ||
| ocmbot | ||
| ocmcli | ||
| ocmconfig | ||
| oncefunc | ||
| oo | ||
|
There was a problem hiding this comment. i There was a problem hiding this comment. I also didn't find any and guess oo can be removed |
||
| oras | ||
| os | ||
| outputspecification | ||
| packagespec | ||
| parameterization | ||
| pendingdeprecationwarning | ||
| pflag | ||
| podinfo | ||
| podman | ||
| pre | ||
| preconfigure | ||
| preconfigured | ||
| predefine | ||
| programmatically | ||
| prs | ||
|
There was a problem hiding this comment. The occurrences of 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 :-) |
||
| pss | ||
| pubsub | ||
| readme | ||
| readonly | ||
| refcount | ||
| relativeocireference | ||
| releaser | ||
| repo | ||
| repocpi | ||
| repositoryimpl | ||
| repositoryspec | ||
| resendbuffer | ||
| resolvers | ||
| resourcereference | ||
| routings | ||
| routingslips | ||
| rsa | ||
| rsakeypair | ||
| runtime | ||
| sbod | ||
| sbom | ||
| sdk | ||
| semver | ||
| sequent | ||
| serializable | ||
| sha | ||
| signingserver | ||
| sigstore | ||
| simplemapmerge | ||
| sonatype | ||
| spdx | ||
| srcrefs | ||
| stderr | ||
| stdin | ||
| stdout | ||
| storable | ||
| struct | ||
| subchart | ||
| subcharts | ||
| subst | ||
| tempfile | ||
| templated | ||
| templater | ||
| templaters | ||
| templating | ||
| tgz | ||
| tls | ||
| todo | ||
| toi | ||
| toiexecutor | ||
| toolset | ||
| transportarchive | ||
| typehandler | ||
| typename | ||
| unmodifiable | ||
| untrusted | ||
| updatevendorhash | ||
| uploader | ||
| uploaderdescriptor | ||
| uploaders | ||
| uploadhandlers | ||
| url | ||
| urls | ||
| utf | ||
| util | ||
| utils | ||
| valuemergehandler | ||
| valuemergehandlerdescriptor | ||
| valueset | ||
| versionedtypedobjects | ||
| walkthrough | ||
| wget | ||
| withocm | ||
| xml | ||
| yaml | ||
| yitsushi | ||
| yml | ||
| yyyy | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We also have
htmlsources 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 thehtml-syntax be too troublesome.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not too convinced that the spell checker really makes sense for html pages and propose to keep the check for markdown only.