Restructure for better rendering on TF Registry #188
Merged
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.
Overview/Summary
Updates the README structure for better rendering on the Terraform Registry.
Once merged, the resulting commit on
main
will be used to rebase releasev1.0.0
as no code changes made to the actual Terraform Module.This PR fixes/adds/changes/removes
3
to2
levels.Documentation
heading removed andToC
reduced tolevel 1
headings only for improved readability.ToC
toExamples
section.Provider Configuration
in theOverview
section.Contributing
section with links to the associated Wiki docs.Breaking Changes
none
Testing Evidence
Benefit of changes will only be visible on Terraform Registry once included in a release.
As part of this Pull Request I have
main
branch/docs/wiki/whats-new.md
)