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

Restructure for better rendering on TF Registry #188

Merged
merged 1 commit into from
Oct 13, 2021

Conversation

krowlandson
Copy link
Contributor

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 release v1.0.0 as no code changes made to the actual Terraform Module.

This PR fixes/adds/changes/removes

  1. Reduces maximum list indentation from 3 to 2 levels.
  2. Documentation heading removed and ToC reduced to level 1 headings only for improved readability.
  3. Links to Wiki examples moved from ToC to Examples section.
  4. Added references to using the Provider Configuration in the Overview section.
  5. Replaced content of the 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

  • Checked for duplicate Pull Requests
  • Associated it with relevant issues, for tracking and closure.
  • Ensured my code/branch is up-to-date with the latest changes in the main branch
  • Performed testing and provided evidence.
  • Updated relevant and associated documentation.
  • Updated the "What's New?" wiki page (located in the Enterprise-Scale repo in the directory: /docs/wiki/whats-new.md)

@krowlandson krowlandson added the documentation Improvements or additions to documentation label Oct 13, 2021
@krowlandson krowlandson requested a review from jtracey93 October 13, 2021 07:18
@krowlandson krowlandson self-assigned this Oct 13, 2021
Copy link
Collaborator

@jtracey93 jtracey93 left a comment

Choose a reason for hiding this comment

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

LGTM 🚢

@jtracey93
Copy link
Collaborator

/azp run unit

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@krowlandson krowlandson merged commit 5b629d3 into Azure:main Oct 13, 2021
@krowlandson krowlandson deleted the patch-readme branch November 29, 2021 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants