This repository has been archived by the owner on Nov 27, 2024. It is now read-only.
Remove unused front-matter from provider documentation #859
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.
Description
This PR:
layout
front-matter from documentation markdown files and template fileslayout
value refers tosidebar_current
front-matter and template files linked to the sidebar navigation in the documentation.The accepted front-matter values in the Registry documentation are
page_title
andsubcategory
. Thedescription
field is less clear - I've been told that it should be being used to set meta tags for SEO even though the documentation doesn't mention this, so best to leave them alone!Other fields like
layout
andsidebar_current
are not supported anymore - e.g. here's an issue in the aws provider that describessidebar_current
needing to be removed. By removing them it'll make it easier to debug documentation issues etcImpact
Lots of markdown files have the 2 fields deleted from them in this PR
Templates and non-markdown files affected:
This PR should not affect the appearance of documentation in the Registry providing that:
subcategory
still setpage_title
still setOpen questions & stuff
During this work I found this PR updating generation of
sidebar_current
in tpgtools - I believe that this could be removed, unless I've misunderstood something!Also I'm aware this change cannot be tested other than by making a release - sorry about that 😬
Depending on how modular-magician works, I think this layout file in the downstream repo might need to be deleted via a PR directly against the downstream?:
References
sidebar_current
is removed.Checklist
If this PR is for Terraform, I acknowledge that I have:
make test
andmake lint
to ensure it passes unit and linter tests.Release Note Template for Downstream PRs (will be copied)
Derived from GoogleCloudPlatform/magic-modules#6238