Skip to content

Contributor Docs: add provider documentation standards page#28611

Merged
sreallymatt merged 5 commits intomainfrom
mp/contributor-docs
Feb 4, 2025
Merged

Contributor Docs: add provider documentation standards page#28611
sreallymatt merged 5 commits intomainfrom
mp/contributor-docs

Conversation

@sreallymatt
Copy link
Copy Markdown
Collaborator

Community Note

  • Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
  • Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

Add page for documentation standards and information on notes.

PR Checklist

  • I have followed the guidelines in our Contributing Documentation.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.
  • I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
  • I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
  • I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
    For example: “resource_name_here - description of change e.g. adding property new_property_name_here

This is a (please select all that apply):

  • Bug Fix
  • New Feature (ie adding a service, resource, or data source)
  • Enhancement
  • Breaking Change

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

@sreallymatt sreallymatt changed the title Contributor Docs: different note formats within provider documentation Contributor Docs: add provider documentation standards page Jan 28, 2025
Copy link
Copy Markdown
Contributor

@stephybun stephybun left a comment

Choose a reason for hiding this comment

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

Thanks @sreallymatt LGTM 🚒

@sreallymatt sreallymatt merged commit 449b2d5 into main Feb 4, 2025
@sreallymatt sreallymatt deleted the mp/contributor-docs branch February 4, 2025 14:50
@github-actions github-actions bot added this to the v4.18.0 milestone Feb 4, 2025
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
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 7, 2025

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.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 7, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants