TF Plugin Docs - migrating to new structure #2470
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
arybolovlev
requested changes
Apr 19, 2024
There was a problem hiding this comment.
I have left a few comments, could you please take a look? Most of them apply to all files in this PR, so I picked up only one and commented there.
One more thing that I have noticed -- doc-gen does not pick up default values. Do you know if there are plans to fix that? It might be crucial for some resources and timeouts.
All in all, great efforts, thank you!
sheneska
force-pushed
the
tf-plugin-docs
branch
from
c8ae89f
to
ebc90a9
Compare
sheneska
changed the title
sheneska
force-pushed
the
tf-plugin-docs
branch
from
ebc90a9
to
f76e775
Compare
SarahFrench
reviewed
Apr 24, 2024
There was a problem hiding this comment.
👋 Hi Sheneska, I saw your post on Slack and took a look at the problem.
It looks like you need to update these files to reflect the new locations of the markdown files:
- This line in .github/workflows/markdown-link-check.yaml
- Times that the Makefile references the old
./websitepath. The Makefile is used in the checkers-and-linters.yaml file, which is linked to one of the checks that's failing.
arybolovlev
approved these changes
Apr 25, 2024
dduportal
referenced
this pull request
in jenkins-infra/azure
May 10, 2024
<Actions>
<action
id="bcd9b70d7c1eb1e07eb5ad8a958f18dc1bbd81461ee1a2604adeea46e3148a47">
<h3>Bump Terraform `kubernetes` provider version</h3>
<details
id="1d9343c012f5434ac9fe8a98135bae3667b399259be16d9b14302ea3bd424a24">
<summary>Update Terraform lock file</summary>
<p>changes detected:
	"hashicorp/kubernetes" updated
from "2.29.0" to "2.30.0" in file
".terraform.lock.hcl"</p>
<details>
<summary>2.30.0</summary>
<pre>Changelog retrieved
from:
	https://github.com/hashicorp/terraform-provider-kubernetes/releases/tag/v2.30.0
BUG
FIXES:

* `data_source/kubernetes_resources`: fix an
issue where the provider exit with an error when the data source
`kubernetes_resources` receives multiple Kubernetes objects containing
tuples with different numbers of elements.
[[GH-2372](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2372)]
*
`kubernetes_manifest`: fix issue preventing KUBE_PROXY_URL environment
variable from being used in client configuration (#1733)
[[GH-2485](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2485)]
*
`resource/kubernetes_node_taint`: Fix the error check for nonexistant
nodes so that terraform does not fail if there is a taint in the state
file for a node that has been deleted.
[[GH-2402](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2402)]

DOCS:

*
Migrate legacy structure to new tfplugindocs template structure
[[GH-2470](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2470)]
</pre>
</details>
</details>
<a
href="https://infra.ci.jenkins.io/job/updatecli/job/azure/job/main/161/">Jenkins
pipeline link</a>
</action>
</Actions>
---
<table>
<tr>
<td width="77">
<img src="https://www.updatecli.io/images/updatecli.png" alt="Updatecli
logo" width="50" height="50">
</td>
<td>
<p>
Created automatically by <a
href="https://www.updatecli.io/">Updatecli</a>
</p>
<details><summary>Options:</summary>
<br />
<p>Most of Updatecli configuration is done via <a
href="https://www.updatecli.io/docs/prologue/quick-start/">its
manifest(s)</a>.</p>
<ul>
<li>If you close this pull request, Updatecli will automatically reopen
it, the next time it runs.</li>
<li>If you close this pull request and delete the base branch, Updatecli
will automatically recreate it, erasing all previous commits made.</li>
</ul>
<p>
Feel free to report any issues at <a
href="https://github.com/updatecli/updatecli/issues">github.com/updatecli/updatecli</a>.<br
/>
If you find this tool useful, do not hesitate to star <a
href="https://github.com/updatecli/updatecli/stargazers">our GitHub
repository</a> as a sign of appreciation, and/or to tell us directly on
our <a
href="https://matrix.to/#/#Updatecli_community:gitter.im">chat</a>!
</p>
</details>
</td>
</tr>
</table>
Co-authored-by: Jenkins Infra Bot (updatecli) <60776566+jenkins-infra-bot@users.noreply.github.com>
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 PR covers the following:
(docs/r)to thetfplugindocssupportedtemplates/structureRelease Note
Release note for CHANGELOG:
References
Community Note