-
Notifications
You must be signed in to change notification settings - Fork 45
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
[Feature]: Increase usage of generation for provider docs #724
Labels
enhancement
New feature or request
Comments
This was referenced Jul 18, 2024
ctreatma
added a commit
that referenced
this issue
Aug 28, 2024
…nventional paths (#763) In an effort to reduce the work required for #724, this renames the existing resource & data source example directories so that they match the [conventional paths](https://github.com/hashicorp/terraform-plugin-docs?tab=readme-ov-file#conventional-paths) for `tfplugindocs`.
ctreatma
added a commit
that referenced
this issue
Sep 9, 2024
This removes custom templates for some Fabric data sources and resources to avoid missed docs changes due to hard-coded docs templates, which partially addresses #724. Changes made here are: in cases where there is a single example file, 1. rename that example to align with [conventional paths for examples in `tfplugindocs`](https://github.com/hashicorp/terraform-plugin-docs?tab=readme-ov-file#conventional-paths) 2. remove the custom template so that the default template is used 3. update the resource/data source description in code to match what was in the previous docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
In v2 we adopted
terraform-plugin-docs
to enable generation of provider docs from provider code. In the initial migration we created templates from the existing docs to minimize the amount of change introduced in a single PR. This means that even though we useterraform-plugin-docs
, we are still generally using it with hand-written, hard-coded templates that are simply copied fromtemplates/
todocs/
. This results in gaps between the attributes that are supported by a given resource or data source and the attributes that are mentioned in the docs.To reduce this gap we should do one of the following for every custom template in
templates/data-sources
andtemplates/resources
:{{ .SchemaMarkdown | trimspace }}
An example of the first approach can be seen in #719.
New or Affected Terraform Resources
This affects documentation for all resources and data sources
Potential Terraform Configuration
This is a documentation change and does not impact terraform configuration
The text was updated successfully, but these errors were encountered: