website: Add subcategories to docs for display on the Terraform Registry #10684
Conversation
justincampbell
force-pushed
the
terraform-registry-docs-preparation
branch
from
3e82e64 to
7a138e0
Compare
bflad
added
documentation
There was a problem hiding this comment.
Thanks, @justincampbell 🚀 Verified all the subcategories match up appropriately.
Before we merge, we should likely go through any affected pull requests (new resource/data source or those adjusting renamed files) to decide how we should handle them.
| @@ -1,4 +1,5 @@ | |||
| --- | |||
| subcategory: "EC2" | |||
There was a problem hiding this comment.
Not for this pull request, but this is confusingly in Autoscaling for the data source and EC2 for the resource. Technically, I think it should be in Autoscaling since that's the service API.
justincampbell
force-pushed
the
terraform-registry-docs-preparation
branch
from
25743ba to
8896d70
Compare
|
@bflad Updated this to not rename any files! Let me know if it's ok to merge soon. |
justincampbell
force-pushed
the
terraform-registry-docs-preparation
branch
2 times, most recently
from
975ae18 to
8a56e46
Compare
This check ensures that all resource and data source docs have a subcategory specified, so that the Terraform Registry can properly render the docs navigation.
This was removed, but should show up in the subcategory on the Terraform Registry, and not the top-level data sources folder.
We will soon be displaying documentation for this provider both on [terraform.io](https://www.terraform.io/docs/providers/index.html) and on [the Terraform Registry](https://registry.terraform.io/providers). Documentation displayed on the Terraform Registry will not use the ERB layout containing the existing navigation, and will instead build the navigation dynamically based on the directory and YAML frontmatter of a file. For providers that group similar resources and data sources by service or use case (subcategories), we'll need to add this information to the Markdown source file. This modifies Resource and Data Source documentation source files by adding a subcategory to the metadata if those files were grouped previously. For more information about how documentation is rendered on the Terraform Registry, please see this reference: [Terraform Registry - Provider Documentation](https://www.terraform.io/docs/registry/providers/docs.html).
justincampbell
force-pushed
the
terraform-registry-docs-preparation
branch
from
8a56e46 to
6050201
Compare
|
This has been released in version 2.35.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks! |
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks! |
ghost
locked and limited conversation to collaborators
We will soon be displaying documentation for this provider both on terraform.io and on the Terraform Registry.
Documentation displayed on the Terraform Registry will not use the ERB layout containing the existing navigation, and will instead build the navigation dynamically based on the directory and YAML frontmatter of a file. For providers that group similar resources and data sources by service or use case (subcategories), we'll need to add this information to the Markdown source file.
This PR modifies resource and data source documentation source files by adding a subcategory to the metadata if those files are currently grouped on terraform.io.
For more information about how documentation is rendered on the Terraform Registry, please see this reference: Terraform Registry - Provider Documentation.
Community Note
Release note for CHANGELOG:
Output from acceptance testing:
$ make docscheck $ # exited 0