📖 Add encoded ConfigSpec examples #438
Merged
Conversation
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
This patch adds some additional documentation for VM classes, as well as a new package to supplement docs with Golang code, pkg/docs. This package includes a file for providing examples of encoded ConfigSpec structures, pkg/docs/concepts/vm-class_test.go.
akutz
force-pushed
the
feature/vmclass-docs
branch
from
f385ea9 to
d345a5e
Compare
Minimum allowed line rate is |
bryanv
approved these changes
Mar 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do, and why is it needed?
This patch adds some additional documentation for VM classes, as well as a new package to supplement docs with Golang code, pkg/docs. This package includes a file for providing examples of encoded ConfigSpec structures, pkg/docs/concepts/vm-class_test.go.
Which issue(s) is/are addressed by this PR? (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes
NAAre there any special notes for your reviewer:
Please add a release note if necessary:
📚 Documentation preview 📚: https://vm-operator--438.org.readthedocs.build/en/438/