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

docs: Documentation bug fixes in README snippets #94

Merged
merged 5 commits into from
Sep 20, 2024

Conversation

stefanskid
Copy link
Contributor

@stefanskid stefanskid commented Sep 13, 2024

Description

The changes apply to the snippets in the README because they did not reflect the modules code after the refactor.

Motivation and Context

#81

How Has This Been Tested?

The snippets were tested manually. After the applied changes, all snippets no longer throw errors during terraform plan.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

@stefanskid stefanskid added the documentation Improvements or additions to documentation label Sep 13, 2024
@stefanskid stefanskid marked this pull request as ready for review September 15, 2024 17:27
@stefanskid stefanskid requested a review from a team as a code owner September 15, 2024 17:27
Copy link
Contributor

@acelebanski acelebanski left a comment

Choose a reason for hiding this comment

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

Great work in general! My comments are mostly referring to the same thing (placeholders). You can even add a TODO comment next to each placeholder, e.g.:

subnet_id = "/subscription/xxxx/......." # TODO: Put your existing subnet ID here

modules/loadbalancer/.header.md Outdated Show resolved Hide resolved
modules/natgw/.header.md Outdated Show resolved Hide resolved
modules/virtual_network_gateway/.header.md Outdated Show resolved Hide resolved
modules/vmss/.header.md Outdated Show resolved Hide resolved
modules/vnet/.header.md Outdated Show resolved Hide resolved
modules/vnet/.header.md Outdated Show resolved Hide resolved
Copy link
Contributor

@acelebanski acelebanski left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@stefanskid stefanskid merged commit 19c9720 into main Sep 20, 2024
23 checks passed
@stefanskid stefanskid deleted the documentation-bug-fix branch September 20, 2024 10:34
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