Generate docs for datasources#17538
Open
roaks3 wants to merge 1 commit into
Open
Conversation
Collaborator
|
Hi there, I'm the Modular magician. I've detected the following information about your changes for commit b015113: Diff reportYour PR generated the following diffs in downstream repositories:
Errors
|
Contributor
Author
|
I think the template check is actually a bug in the check: Looks like it only considers new templates, but would otherwise flag any of our other generic templates. |
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Part of hashicorp/terraform-provider-google#25987
This adds docs generation for datasources that are generated. The structure is fairly standardized to begin with, and I tried to use the wording that was most commonly used thus far.
The main parts that were more ambiguous:
firstSentence, but I'm a bit worried about how reliably it will be, especially since most contributors will not check what documentation was generated.I think in its current state, this should be fine to advance forward and help make datasource creation much easier, but open to feedback of course.
For awareness: this started out as a heavily AI-assisted solution, but by the end I was making a lot of hand edits. The result is a bit of a mix + manual verification and testing that I did.
Release Note Template for Downstream PRs (will be copied)
See Write release notes for guidance.