Skip to content
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

website: Add subcategories to docs for display on the Terraform Registry #4795

Closed

Conversation

findkim
Copy link
Contributor

@findkim findkim commented Nov 1, 2019

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.

@findkim findkim force-pushed the terraform-registry-docs-preparation-subcategories branch from 395d582 to 9f7bc14 Compare November 1, 2019 21:16
@chrisst chrisst self-assigned this Nov 2, 2019
@findkim
Copy link
Contributor Author

findkim commented Nov 5, 2019

Thanks @chrisst for moving these changes to the upstream docs! GoogleCloudPlatform/magic-modules#2585

I'll close this one out and open up one with just the docscheck CI changes.

@findkim findkim closed this Nov 5, 2019
@findkim findkim deleted the terraform-registry-docs-preparation-subcategories branch November 5, 2019 20:35
@ghost
Copy link

ghost commented Dec 6, 2019

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. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 [email protected]. Thanks!

@ghost ghost locked and limited conversation to collaborators Dec 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants