Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 29, 2025

This PR fixes an issue where the Terraform Registry documentation was displaying "gridscale_securityzone" in the left sidebar navigation instead of the correct resource name "gridscale_paas_securityzone".

Problem

The sidebar navigation in the Terraform Registry docs showed an incorrect resource name due to mismatched sidebar_current values between the documentation files and the navigation template.

Root Cause

The sidebar_current metadata in both the resource and data source documentation files did not match the corresponding references in website/gridscale.erb:

  • Navigation template expected: "docs-gridscale-resource-paas-securityzone"

  • Resource doc had: "docs-gridscale-resource-securityzone"

  • Navigation template expected: "docs-gridscale-datasource-paas-securityzone"

  • Data source doc had: "docs-gridscale-datasource-securityzone"

Solution

Updated the sidebar_current values in both documentation files to match the navigation template:

  • website/docs/r/securityzone.html.md: Updated to "docs-gridscale-resource-paas-securityzone"
  • website/docs/d/securityzone.html.md: Updated to "docs-gridscale-datasource-paas-securityzone"

This ensures the sidebar navigation correctly displays "gridscale_paas_securityzone" for both the resource and data source documentation pages.

Verification

  • ✅ Build passes without issues
  • ✅ Navigation references now match documentation metadata
  • ✅ No other files required changes
  • ✅ Minimal, surgical fix with only 2 lines changed total

Closes #[issue_number]

Original prompt

This section details on the original issue you should resolve

<issue_title>Docs: wrong name of "gridscale_paas_securityzone" in tree on the left</issue_title>
<issue_description>The docs available on Terraform's registry list the resource name as gridscale_securityzone in its index on the left, even though the contents on the right use the correct name gridscale_paas_securityzone. My guess is that this is due to the corresponding file having the wrong name.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #200

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI changed the title [WIP] Docs: wrong name of "gridscale_paas_securityzone" in tree on the left Fix documentation navigation for gridscale_paas_securityzone Sep 29, 2025
Copilot AI requested a review from fabiante September 29, 2025 12:05
Copilot finished work on behalf of fabiante September 29, 2025 12:05
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.

Docs: wrong name of "gridscale_paas_securityzone" in tree on the left

2 participants