Remove page_title attribute from frontmatter in resource documentation, update external link
#13579
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
…ion, update external link (hashicorp#7151) * Remove `page_title` frontmatter from generated resource documentation * Update link to custom timeouts in HashiCorp docs * Remove `page_title` frontmatter from generated IAM resource documentation * Remove `page_title` frontmatter from tpgtools documentation template * Remove use of `page_title` in handwritten resource/datasource docs * Update link to custom timeout docs in handwritten resource/datasource docs * Update link to custom timeout docs in tpgtools docs template Signed-off-by: Modular Magician <[email protected]>
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. |
modular-magician
deleted the
downstream-pr-62a62f251ee61797c7665a8c431942948f69c4ae
branch
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR removes a line from the template used to generated markdown files documenting MMv1 resources. Currently the template adds a
page_titleattribute in the YAML frontmatter of each resource's markdown file, but this field is not required for resource documentation. The documentation for provider documentation describes how this attribute is only needed for files in the/guidesfolder. Those files are all handwritten and not related to this template, so it's safe to remove this field from the template.This PR also updates a link in the
Timeoutssection in the docs (example here) . The template currently includes a link to the old documentation that was hosted at terraform.io. Although the old link is redirected to the new developer.hashicorp.com website, the docs have changed and the link doesn't send users to a relevant page.If this PR is for Terraform, I acknowledge that I have:
make testandmake lintto ensure it passes unit and linter tests.[x] Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).Release Note Template for Downstream PRs (will be copied)
Derived from GoogleCloudPlatform/magic-modules#7151