Documentation fix on github_repository_environment (#829)

eerkunt · web-flow · commit 4e4522290b37 · 2021-06-25T17:09:50.000-04:00
This PR will fix the documentation about the `github_repository_environment` resource, where one of the parameters where named wrong.
diff --git a/website/docs/r/repository_environment.html.markdown b/website/docs/r/repository_environment.html.markdown
@@ -17,7 +17,7 @@ data "github_user" "current" {
 }
 
 resource "github_repository" "example" {
-  name         = "example"
+  environment  = "example"
   description  = "My awesome codebase"
 }
 
@@ -38,7 +38,7 @@ resource "github_repository_environment" "example" {
 
 The following arguments are supported:
 
-* `name` - (Required) The name of the environment.
+* `environment` - (Required) The name of the environment.
 
 * `repository` - (Required) The repository of the environment.
 
@@ -58,4 +58,4 @@ The `deployment_branch_policy` block supports the following:
 
 * `protected_branches` - (Required) Whether only branches with branch protection rules can deploy to this environment.
 
-* `custom_branch_policies` - (Required) Whether only branches that match the specified name patterns can deploy to this environment.
+* `custom_branch_policies` - (Required) Whether only branches that match the specified name patterns can deploy to this environment.

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ data "github_user" "current" {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`resource "github_repository" "example" {`
`20`		`- name = "example"`
	`20`	`+ environment = "example"`
`21`	`21`	`description = "My awesome codebase"`
`22`	`22`	`}`
`23`	`23`
`@@ -38,7 +38,7 @@ resource "github_repository_environment" "example" {`
`38`	`38`
`39`	`39`	`The following arguments are supported:`
`40`	`40`
`41`		-* `name` - (Required) The name of the environment.
	`41`	+* `environment` - (Required) The name of the environment.
`42`	`42`
`43`	`43`	* `repository` - (Required) The repository of the environment.
`44`	`44`
@@ -58,4 +58,4 @@ The `deployment_branch_policy` block supports the following:
`58`	`58`
`59`	`59`	* `protected_branches` - (Required) Whether only branches with branch protection rules can deploy to this environment.
`60`	`60`
`61`		-* `custom_branch_policies` - (Required) Whether only branches that match the specified name patterns can deploy to this environment.
	`61`	+* `custom_branch_policies` - (Required) Whether only branches that match the specified name patterns can deploy to this environment.