Contributor Docs: add provider documentation standards page#28611
Merged
sreallymatt merged 5 commits intomainfrom Feb 4, 2025
Merged
Contributor Docs: add provider documentation standards page#28611sreallymatt merged 5 commits intomainfrom
sreallymatt merged 5 commits intomainfrom
Conversation
stephybun
reviewed
Jan 28, 2025
stephybun
reviewed
Jan 31, 2025
stephybun
approved these changes
Feb 4, 2025
Contributor
stephybun
left a comment
There was a problem hiding this comment.
Thanks @sreallymatt LGTM 🚒
hqhqhqhqhqhqhqhqhqhqhq
pushed a commit
to hqhqhqhqhqhqhqhqhqhqhq/terraform-provider-azurerm
that referenced
this pull request
Feb 26, 2025
…p#28611) * Add documentation standards page * Adding examples of inconsistencies and expected format * casing > capatlisation for clarity * Add paragraph on breaking changes notes * Add newline for consistency
Contributor
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Community Note
Description
Add page for documentation standards and information on notes.
PR Checklist
For example: “
resource_name_here- description of change e.g. adding propertynew_property_name_here”This is a (please select all that apply):
Note
If this PR changes meaningfully during the course of review please update the title and description as required.