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

Remove page_title attribute from frontmatter in resource documentation, update external link #7151

Merged

Conversation

SarahFrench
Copy link
Contributor

@SarahFrench SarahFrench commented Jan 20, 2023

This PR removes a line from the template used to generated markdown files documenting MMv1 resources. Currently the template adds a page_title attribute 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 /guides folder. 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 Timeouts section 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:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Generated Terraform, and ran make test and make lint to 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).
  • Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)


@SarahFrench SarahFrench force-pushed the update-generated-docs-template branch from d8d5547 to 9d91ec9 Compare January 20, 2023 16:02
@@ -173,7 +172,7 @@ In addition to the arguments listed above, the following computed attributes are
## Timeouts

This resource provides the following
[Timeouts](/docs/configuration/resources.html#timeouts) configuration options:
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't use the relative link anymore as docs have moved away from the terraform.io domain

@SarahFrench SarahFrench requested a review from shuyama1 January 20, 2023 16:09
@SarahFrench
Copy link
Contributor Author

Realised there are a ton of other templates - marking as draft until I've found them all

@SarahFrench SarahFrench marked this pull request as draft January 20, 2023 16:15
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 363 files changed, 296 insertions(+), 659 deletions(-))
Terraform Beta: Diff ( 363 files changed, 296 insertions(+), 659 deletions(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 632 files changed, 296 insertions(+), 928 deletions(-))
Terraform Beta: Diff ( 632 files changed, 296 insertions(+), 928 deletions(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 632 files changed, 374 insertions(+), 1006 deletions(-))
Terraform Beta: Diff ( 632 files changed, 374 insertions(+), 1006 deletions(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@SarahFrench SarahFrench marked this pull request as ready for review January 20, 2023 18:11
@SarahFrench
Copy link
Contributor Author

This PR is similar to this past PR that also cleaned up usage of frontmatter in the provider documentation.

Sorry that there are a lot of file changes (here and in the downstream). If it helps with reviewing this PR, the changes to the handwritten files were achieved using a global search and replace, where I searched with this regex (\npage_title: "Google: google_[a-z_]+") and replaced with nothing.

Copy link
Member

@shuyama1 shuyama1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks!

@SarahFrench SarahFrench merged commit 62a62f2 into GoogleCloudPlatform:main Jan 26, 2023
ericayyliu pushed a commit to ericayyliu/magic-modules that referenced this pull request Jul 26, 2023
…ion, update external link (GoogleCloudPlatform#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
@SarahFrench SarahFrench deleted the update-generated-docs-template branch March 26, 2024 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants