metal3-io / metal3-docs

Architecture documentation that describes the components being built under Metal³.
http://metal3.io
Apache License 2.0
263 stars 111 forks source link

add spellchecker, and fix pre-existing issues #379

Closed tuminoid closed 5 months ago

tuminoid commented 5 months ago

Add spellchecker to keep our documentation in good shape. Fix pre-existing issues, and add some words to the words list. The base word list is imported from website repository, and then cleaned up from the words not appearing in this repository.

Add shellcheck to lint these hack scripts.

Needs https://github.com/metal3-io/project-infra/pull/625 to merge first. /hold

tuminoid commented 5 months ago

/cc @Rozzii @kashifest @lentzi90

metal3-io-bot commented 5 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kashifest

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/metal3-io/metal3-docs/blob/main/OWNERS)~~ [kashifest] - ~~[design/OWNERS](https://github.com/metal3-io/metal3-docs/blob/main/design/OWNERS)~~ [kashifest] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
metal3-io-bot commented 5 months ago

@smoshiur1237: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to [this](https://github.com/metal3-io/metal3-docs/pull/379#pullrequestreview-1848622787): >/lgtm Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
tuminoid commented 5 months ago

/retest With new checks enabled.

tuminoid commented 5 months ago

/unhold Good to go.