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 |
Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>
c46c825 to
300f5b8
Compare
|
There is a new one #3241 duplication |
deiga
left a comment
There was a problem hiding this comment.
Added some non-critical suggestions. I didn't review all the templates as I think you made as small as possible changes.
What else can I do to help get this merged?
There was a problem hiding this comment.
I would propose moving linting, testing and docs validation into separate jobs to get parallel runs that don't block each other
| //go:generate go tool github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --rendered-provider-name=GitHub | ||
|
|
||
| // Check for misspellings in documentation. | ||
| //go:generate go tool github.com/client9/misspell/cmd/misspell -error -i "docs/**/*.md" |
There was a problem hiding this comment.
suggestion: since the client9/misspell hasn't been updated in a while and there exists a maintained fork https://github.com/golangci/misspell, should we use that instead?
| @@ -1,4 +1,4 @@ | |||
| # Hi fellow bots and humans :wave: | |||
| # Hi fellow bots and humans :wave | |||
There was a problem hiding this comment.
Accidental deeltion?
| # Hi fellow bots and humans :wave | |
| # Hi fellow bots and humans :wave: |
| [per-file-ignores] | ||
| ".github/pull_request_template.md" = ["MD041"] | ||
| "docs/**/*.md" = ["MD059"] | ||
|
|
There was a problem hiding this comment.
I think we wanted to consolidate on using dash for UL, right? We could add this rule then
| [MD004] | |
| style = "dash" | |
| ".github/pull_request_template.md" = ["MD041"] | ||
| "docs/**/*.md" = ["MD059"] | ||
|
|
||
| [MD024] |
There was a problem hiding this comment.
I think it might be worth setting the list indentation to 4, though I can't recall why that was 😬
| [MD024] | |
| [MD007] | |
| indent = 4 | |
| [MD024] |
| ## Argument Reference | ||
|
|
||
| - `repository` - (Required) Name of the repository to get public key from. | ||
| - `environment` - (Required) Name of the environment to get public key from. | ||
|
|
||
| ## Attributes Reference | ||
|
|
||
| - `key_id` - ID of the key that has been retrieved. | ||
| - `key` - Actual key retrieved. |
There was a problem hiding this comment.
Have you considered using an even more automatic approach here? Or would you like to do ~minimal changes now and then ramping up ~full automation level?
| ## Argument Reference | |
| - `repository` - (Required) Name of the repository to get public key from. | |
| - `environment` - (Required) Name of the environment to get public key from. | |
| ## Attributes Reference | |
| - `key_id` - ID of the key that has been retrieved. | |
| - `key` - Actual key retrieved. | |
| {{ .SchemaMarkdown | trimspace }} |
Resolves #2924
Resolves #2961
Resolves #2897
Resolves #3241
Closes #2987
Before the change?
After the change?
tfplugindocsPull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!