Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation fix typo "an MacOS" to "on MacOS" #10179

Merged
merged 1 commit into from
Jan 21, 2025
Merged

Conversation

FlogFr
Copy link

@FlogFr FlogFr commented Jan 20, 2025

Pull Request

I am discovering this amazing project ! Thank you very much for it.
During reading the documentation I found this typo. I open this PR to fix it.

What? (description)

Documentation typo.

Why? (reasoning)

Acceptance

Please use the following checklist:

  • you linked an issue (if applicable)
  • you included tests (if applicable)
  • you ran conformance (make conformance)
  • you formatted your code (make fmt)
  • you linted your code (make lint)
  • you generated documentation (make docs) . make docs fail on the following error :
7.750 2025/01/20 19:48:49 generating docs for type: "KernelModuleConfig"
------
Dockerfile:355
--------------------
 353 |     RUN gofumpt -w ./pkg/
 354 |     WORKDIR /src/pkg/machinery
 355 | >>> RUN --mount=type=cache,target=/.cache go generate ./...
 356 |     RUN gotagsrewrite .
 357 |     RUN goimports -w -local github.com/siderolabs/talos ./
--------------------
ERROR: failed to solve: process "/toolchain/bin/bash -c go generate ./..." did not complete successfully: exit code: 1
  • you ran unit-tests (make unit-tests)

See make help for a description of the available targets.

Copy link
Member

@smira smira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you!

Update all docs.

Signed-off-by: Andrey Smirnov <[email protected]>
Signed-off-by: Florian Grignon <[email protected]>
@smira
Copy link
Member

smira commented Jan 21, 2025

/m

@talos-bot talos-bot merged commit 33c7f41 into siderolabs:main Jan 21, 2025
50 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants