docs: more descriptive markdown example for metal_port #229
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
ctreatma
force-pushed
the
port_example_markdown
branch
2 times, most recently
from
a528fc1 to
404c2bf
Compare
ctreatma
changed the title
ctreatma
force-pushed
the
port_example_markdown
branch
from
404c2bf to
6717c9e
Compare
ocobles
approved these changes
Oct 2, 2024
|
This PR is included in version 0.11.0 🎉 |
1 similar comment
|
This PR is included in version 0.11.0 🎉 |
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.
The generated Ansible collection docs don't give us much leeway to describe example task configurations in detail.
The goal of this PR is to add a separate, hand-written Markdown example that provides more detail as to the purpose/effect of different combinations of arguments for the
metal_portmodule.The example includes a playbook that largely duplicates the existing integration tests for the
metal_portmodule, with aREADME.mdalongside the playbook that describes the functionality of each task, analogous to the network types guide for the Terraform provider.