doc(github_repository_webhook): Update GitHub repository webhook doc#3289
doc(github_repository_webhook): Update GitHub repository webhook doc#3289ViacheslavKudinov wants to merge 7 commits into
Conversation
|
👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with |
fe3e5e5 to
554e329
Compare
deiga
left a comment
There was a problem hiding this comment.
Your commit history in this PR seems off :/
Instead of needing to explain foo-org and foo what if we change them to example-owner and example-repo?
e3288a7 to
5641626
Compare
updated, hope its better |
5641626 to
8aa335c
Compare
8aa335c to
c680430
Compare
c680430 to
fec963f
Compare
|
|
deiga
left a comment
There was a problem hiding this comment.
Files inside docs/ folder are generated files. You'll need to update the templates, examples and imports if you want to update this
|
@deiga Could someone update Contributing to make it clear how we manage doc ? |
Yep, will do, thanks. PS But previous comment to update Contributing file still could help |
12c3e9c to
f4461bb
Compare
0f6f8fe to
916f7c4
Compare
916f7c4 to
199780c
Compare
|
need to update similarly as #3414 |
8d8ebdd to
8f8e02e
Compare
8f8e02e to
f92f26b
Compare
There was a problem hiding this comment.
Pull request overview
These provider review instructions are being used. This PR updates the github_repository_webhook documentation and examples to consistently use the same repository name/webhook ID and to correct the import syntax (per #3285).
Changes:
- Switch the repository webhook docs template to the standard tfplugindocs pattern (examples via
.ExampleFiles, schema via.SchemaMarkdown, and structured Import sections). - Update provider schema descriptions to improve generated docs (including adding an
etagdescription and linking to relevant API docs forsecret). - Add/adjust example and import snippets to use consistent names and the correct
<repo>/<webhook_id>import format.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| templates/resources/repository_webhook.md.tmpl | Converts the doc template to the standard schema/examples/import rendering pattern and updates import wording. |
| github/schema_webhook_configuration.go | Enhances the secret attribute description with an API doc link for generated documentation. |
| github/resource_github_repository_webhook.go | Adds resource-level description, improves events description, adds etag description (but still has an incorrect url description). |
| examples/resources/github_repository_webhook/resource-1.tf | Renames example resources/values for consistency (example-repo, example_webhook). |
| examples/resources/github_repository_webhook/import.sh | Adds corrected CLI import example using example-repo/123456789. |
| examples/resources/github_repository_webhook/import-by-string-id.tf | Adds Terraform import block example using example-repo/123456789. |
| docs/resources/repository_webhook.md | Regenerated/updated docs reflecting the new template and corrected import examples. |
| Type: schema.TypeString, | ||
| Computed: true, | ||
| Description: "Configuration block for the webhook", | ||
| Description: "Configuration block for the webhook.", |
There was a problem hiding this comment.
@deiga how should we react on Copilot reviews ?
There was a problem hiding this comment.
@ViacheslavKudinov You review the comments and decide if they make sense. If you don't know, ask from other maintainers
Resolves #3285
Before the change?
After the change?
Pull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!