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

Fix documentation #728

Merged
merged 3 commits into from
Nov 13, 2024
Merged

Fix documentation #728

merged 3 commits into from
Nov 13, 2024

Conversation

andreiltd
Copy link
Contributor

@andreiltd andreiltd commented Nov 12, 2024

This patch includes several documentation improvements:

  • fixing documentation tests,
  • adding documentation tests to CI,
  • running typos fixes on the repo,
  • adding typos step in the CI,
  • adding wasi-http documentation to docs,
  • follow guidelines on CamelCase naming conventions.

@andreiltd andreiltd marked this pull request as draft November 12, 2024 15:47
@andreiltd andreiltd changed the title Fix documentation tests and add tests to CI Fix documentation Nov 12, 2024
@andreiltd andreiltd marked this pull request as ready for review November 12, 2024 17:01
jprendes
jprendes previously approved these changes Nov 12, 2024
Copy link
Collaborator

@jprendes jprendes left a comment

Choose a reason for hiding this comment

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

Thanks @andreiltd , this is a great and much needed contribution!

docs/wasmtime-shim-wasi-http.md Outdated Show resolved Hide resolved
docs/wasmtime-shim-wasi-http.md Outdated Show resolved Hide resolved
docs/wasmtime-shim-wasi-http.md Outdated Show resolved Hide resolved
@jprendes
Copy link
Collaborator

There are still some typos that need fixing for CI to pass

@andreiltd
Copy link
Contributor Author

Yes, I was running typos --write-changes but apparently there were some no obvious fixes that typos couldn't resolve on its own.

@jprendes
Copy link
Collaborator

Oh, I see you removed the OCI precompilation doc. Was that intentional? Is that coming in a different PR?

jprendes
jprendes previously approved these changes Nov 12, 2024
Copy link
Collaborator

@jprendes jprendes left a comment

Choose a reason for hiding this comment

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

LGTM!
Thanks @andreiltd !

@andreiltd
Copy link
Contributor Author

Oh, I see you removed the OCI precompilation doc. Was that intentional? Is that coming in a different PR?

I think I only renamed the file docs/oci-descision-flow.md → docs/oci-decision-flow.md because there was a typo in file name.

- fixing documentation tests,
- adding documentation tests to CI,
- running typos fixes on the repo,
- adding typos step in the CI,
- adding wasi-http documentation to docs,
- follow guidelines on CamelCase naming conventions.
jprendes
jprendes previously approved these changes Nov 13, 2024
Copy link
Collaborator

@jprendes jprendes left a comment

Choose a reason for hiding this comment

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

LGTM

crates/containerd-shim-wasmtime/README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@jprendes jprendes left a comment

Choose a reason for hiding this comment

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

LGTM!
Thanks @andreiltd !

@jprendes jprendes merged commit bb73dcf into containerd:main Nov 13, 2024
56 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants