fix: Correct documentation samples to resolve generation & injection issues #572
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
lgarber-akamai
added
the
documentation
lgarber-akamai
changed the title
lgarber-akamai
commented
Aug 21, 2024
plugins/modules/lke_cluster.py
Outdated
| @@ -225,11 +225,13 @@ | |||
| "NOTE: This value may be unavailable if `skip_polling` is true.", | |||
| docs_url="https://techdocs.akamai.com/linode-api/reference/get-lke-cluster-kubeconfig", | |||
| type=FieldType.string, | |||
| sample=["\"a3ViZWNvbmZpZyBjb250ZW50Cg==\""] | |||
There was a problem hiding this comment.
We'll need a separate ticket to make sure we're parsing the sample according the the type, but this works for now 🙂
ykim-akamai
requested review from
a team,
zliang-akamai and
ykim-akamai
and removed request for
a team
ykim-akamai
approved these changes
Aug 21, 2024
lgarber-akamai
added a commit
that referenced
this pull request
Aug 22, 2024
Bring #572 to `dev` branch
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.
📝 Description
This pull request resolves various documentation issues that prevented ansible-specdoc from properly generating and injecting documentation at release-time.
NOTE: Once this fix has been merged, we will need a release PR to get this fix into
dev.✔️ How to Test
make inject.ansible-test sanity --test ansible-doccommand does not raise any errors/warnings.