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

docs: Update documentation on balloon device #4996

Merged

Conversation

JackThomson2
Copy link
Contributor

Changes

Add notes around known limitations of the balloon device

Reason

Add clarification around issues customers may encounter when using the balloon device

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.

PR Checklist

  • I have read and understand CONTRIBUTING.md.
  • I have run tools/devtool checkstyle to verify that the PR passes the
    automated style checks.
  • I have described what is done in these changes, why they are needed, and
    how they are solving the problem in a clear and encompassing way.
  • I have updated any relevant documentation (both in code and in the docs)
    in the PR.
  • I have mentioned all user-facing changes in CHANGELOG.md.
  • If a specific issue led to this PR, this PR closes the issue.
  • When making API changes, I have followed the
    Runbook for Firecracker API changes.
  • I have tested all new and changed functionalities in unit tests and/or
    integration tests.
  • I have linked an issue to every new TODO.

  • This functionality cannot be added in rust-vmm.

@JackThomson2 JackThomson2 added Type: Documentation Indicates a need for improvements or additions to documentation Status: Awaiting review Indicates that a pull request is ready to be reviewed labels Jan 15, 2025
@JackThomson2 JackThomson2 force-pushed the docs/update_balloon_device branch from a488b43 to bf1a7d8 Compare January 17, 2025 16:12
Add notes around known limitations of the balloon device

Signed-off-by: Jack Thomson <[email protected]>
@JackThomson2 JackThomson2 force-pushed the docs/update_balloon_device branch from bf1a7d8 to c7d5619 Compare January 17, 2025 16:14
@JackThomson2 JackThomson2 merged commit 2b3ec74 into firecracker-microvm:main Jan 20, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Awaiting review Indicates that a pull request is ready to be reviewed Type: Documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants