Merge pull request #93 from terraform-google-modules/mpell/regen-docs

Regenerate docs

README.md

@@ -87,50 +87,51 @@ The roles granted are specifically:
 
 [^]: (autogen_docs_start)
 
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| activate_apis | The list of apis to activate within the project | list | `<list>` | no |
-| api_sa_group | A GSuite group to place the Google APIs Service Account for the project in | string | `` | no |
-| app_engine | A map for app engine configuration | map | `<map>` | no |
-| auto_create_network | Create the default network | string | `false` | no |
-| billing_account | The ID of the billing account to associate this project with | string | - | yes |
-| bucket_name | A name for a GCS bucket to create (in the bucket_project project), useful for Terraform state (optional) | string | `` | no |
-| bucket_project | A project to create a GCS bucket (bucket_name) in, useful for Terraform state (optional) | string | `` | no |
-| create_group | Whether to create the group or not | string | `false` | no |
-| credentials_path | Path to a Service Account credentials file with permissions documented in the readme | string | - | yes |
-| folder_id | The ID of a folder to host this project | string | `` | no |
-| group_name | A group to control the project by being assigned group_role - defaults to ${project_name}-editors | string | `` | no |
-| group_role | The role to give the controlling group (group_name) over the project (defaults to project editor) | string | `roles/editor` | no |
+| activate\_apis | The list of apis to activate within the project | list | `<list>` | no |
+| api\_sa\_group | A GSuite group to place the Google APIs Service Account for the project in | string | `` | no |
+| app\_engine | A map for app engine configuration | map | `<map>` | no |
+| auto\_create\_network | Create the default network | string | `false` | no |
+| billing\_account | The ID of the billing account to associate this project with | string | - | yes |
+| bucket\_name | A name for a GCS bucket to create (in the bucket_project project), useful for Terraform state (optional) | string | `` | no |
+| bucket\_project | A project to create a GCS bucket (bucket_name) in, useful for Terraform state (optional) | string | `` | no |
+| create\_group | Whether to create the group or not | string | `false` | no |
+| credentials\_path | Path to a Service Account credentials file with permissions documented in the readme | string | - | yes |
+| domain | The domain name (optional if `org_id` is passed) | string | `` | no |
+| folder\_id | The ID of a folder to host this project | string | `` | no |
+| group\_name | A group to control the project by being assigned group_role (defaults to project editor) | string | `` | no |
+| group\_role | The role to give the controlling group (group_name) over the project (defaults to project editor) | string | `roles/editor` | no |
 | labels | Map of labels for project | map | `<map>` | no |
+| lien | Add a lien on the project to prevent accidental deletion | string | `false` | no |
 | name | The name for the project | string | - | yes |
-| org_id | The organization id for the associated services | string | - | yes |
-| random_project_id | Enables project random id generation | string | `false` | no |
-| sa_group | A GSuite group to place the default Service Account for the project in | string | `` | no |
-| sa_role | A role to give the default Service Account for the project (defaults to none) | string | `` | no |
-| shared_vpc | The ID of the host project which hosts the shared VPC | string | `` | no |
-| shared_vpc_subnets | List of subnets fully qualified subnet IDs (ie. projects/$project_id/regions/$region/subnetworks/$subnet_id) | list | `<list>` | no |
-| usage_bucket_name | Name of a GCS bucket to store GCE usage reports in (optional) | string | `` | no |
-| usage_bucket_prefix | Prefix in the GCS bucket to store GCE usage reports in (optional) | string | `` | no |
+| org\_id | The organization id (optional if `domain` is passed) | string | `` | no |
+| random\_project\_id | Enables project random id generation | string | `false` | no |
+| sa\_group | A GSuite group to place the default Service Account for the project in | string | `` | no |
+| sa\_role | A role to give the default Service Account for the project (defaults to none) | string | `` | no |
+| shared\_vpc | The ID of the host project which hosts the shared VPC | string | `` | no |
+| shared\_vpc\_subnets | List of subnets fully qualified subnet IDs (ie. projects/$project_id/regions/$region/subnetworks/$subnet_id) | list | `<list>` | no |
+| usage\_bucket\_name | Name of a GCS bucket to store GCE usage reports in (optional) | string | `` | no |
+| usage\_bucket\_prefix | Prefix in the GCS bucket to store GCE usage reports in (optional) | string | `` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| app_engine_enabled | Whether app engine is enabled |
+| app\_engine\_enabled | Whether app engine is enabled |
 | domain | The organization's domain |
-| group_email | The email of the created GSuite group with group_name |
-| project_bucket_self_link | Project's bucket selfLink |
-| project_bucket_url | Project's bucket url |
-| project_id |  |
-| project_number |  |
-| service_account_display_name | The display name of the default service account |
-| service_account_email | The email of the default service account |
-| service_account_id | The id of the default service account |
-| service_account_name | The fully-qualified name of the default service account |
-| service_account_unique_id | The unique id of the default service account |
+| group\_email | The email of the created GSuite group with group_name |
+| project\_bucket\_self\_link | Project's bucket selfLink |
+| project\_bucket\_url | Project's bucket url |
+| project\_id | - |
+| project\_number | - |
+| service\_account\_display\_name | The display name of the default service account |
+| service\_account\_email | The email of the default service account |
+| service\_account\_id | The id of the default service account |
+| service\_account\_name | The fully-qualified name of the default service account |
+| service\_account\_unique\_id | The unique id of the default service account |
 
 [^]: (autogen_docs_end)
 
@@ -404,4 +405,4 @@ versions][release-new-version].
 [terraform-provider-google]: https://github.com/terraform-providers/terraform-provider-google
 [terraform-provider-gsuite]: https://github.com/DeviaVir/terraform-provider-gsuite
 [glossary]: /docs/GLOSSARY.md
-[release-new-version]: https://www.terraform.io/docs/registry/modules/publish.html#releasing-new-versions
+[release-new-version]: https://www.terraform.io/docs/registry/modules/publish.html#releasing-new-versions

examples/app_engine/README.md

@@ -14,21 +14,20 @@ Expected variables:
 
 [^]: (autogen_docs_start)
 
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| admin_email | Admin user email on Gsuite | string | - | yes |
-| billing_account | The ID of the billing account to associate this project with | string | - | yes |
-| organization_id | The organization id for the associated services | string | - | yes |
+| admin\_email | Admin user email on Gsuite | string | - | yes |
+| billing\_account | The ID of the billing account to associate this project with | string | - | yes |
+| organization\_id | The organization id for the associated services | string | - | yes |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| app_engine_enabled_example | Whether app engine is enabled |
-| domain_example | The organization's domain |
-| project_info_example | The ID of the created project |
+| app\_engine\_enabled\_example | Whether app engine is enabled |
+| domain\_example | The organization's domain |
+| project\_info\_example | The ID of the created project |
 
 [^]: (autogen_docs_end)

examples/gke_shared_vpc/README.md

@@ -22,15 +22,14 @@ More information about GKE with Shared VPC can be found here: https://cloud.goog
 
 [^]: (autogen_docs_start)
 
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| billing_account | billing account | string | - | yes |
-| credentials_path | Path to a Service Account credentials file with permissions documented in the readme | string | - | yes |
-| org_id | organization id | string | - | yes |
-| shared_vpc | The ID of the host project which hosts the shared VPC | string | - | yes |
-| shared_vpc_subnets | List of subnets fully qualified subnet IDs (ie. projects/$PROJECT_ID/regions/$REGION/subnetworks/$SUBNET_ID) | list | `<list>` | no |
+| billing\_account | billing account | string | - | yes |
+| credentials\_path | Path to a Service Account credentials file with permissions documented in the readme | string | - | yes |
+| org\_id | organization id | string | - | yes |
+| shared\_vpc | The ID of the host project which hosts the shared VPC | string | - | yes |
+| shared\_vpc\_subnets | List of subnets fully qualified subnet IDs (ie. projects/$PROJECT_ID/regions/$REGION/subnetworks/$SUBNET_ID) | list | `<list>` | no |
 
 [^]: (autogen_docs_end)

examples/group_project/README.md

@@ -16,24 +16,23 @@ Expected variables:
 
 [^]: (autogen_docs_start)
 
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| admin_email | Admin user email on Gsuite | string | - | yes |
-| api_sa_group | An existing GSuite group email to place the Google APIs Service Account for the project in | string | - | yes |
-| billing_account | The ID of the billing account to associate this project with | string | - | yes |
-| credentials_file_path | Service account json auth path | string | - | yes |
-| organization_id | The organization id for the associated services | string | - | yes |
-| project_group_name | The name of a GSuite group to create for controlling the project | string | `group-sample-project-owners` | no |
+| admin\_email | Admin user email on Gsuite | string | - | yes |
+| api\_sa\_group | An existing GSuite group email to place the Google APIs Service Account for the project in | string | - | yes |
+| billing\_account | The ID of the billing account to associate this project with | string | - | yes |
+| credentials\_file\_path | Service account json auth path | string | - | yes |
+| organization\_id | The organization id for the associated services | string | - | yes |
+| project\_group\_name | The name of a GSuite group to create for controlling the project | string | `group-sample-project-owners` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| domain_example | The organization's domain |
-| group_email_example | The email of the created GSuite group |
-| project_info_example | The ID of the created project |
+| domain\_example | The organization's domain |
+| group\_email\_example | The email of the created GSuite group |
+| project\_info\_example | The ID of the created project |
 
 [^]: (autogen_docs_end)

examples/project-hierarchy/README.md

@@ -22,22 +22,21 @@ Expected variables:
 
 [^]: (autogen_docs_start)
 
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| admin_email | Admin user email on Gsuite | string | - | yes |
-| billing_account | The ID of the billing account to associate this project with | string | - | yes |
-| organization_id | The organization id for the associated services | string | - | yes |
-| credentials_path | Path to a Service Account credentials file with permissions documented in the readme and above| string | - | yes |
+| admin\_email | Admin user email on Gsuite | string | - | yes |
+| billing\_account | The ID of the billing account to associate this project with | string | - | yes |
+| credentials\_path | Path to a Service Account credentials file with permissions documented in the readme | string | - | yes |
+| organization\_id | The organization id for the associated services | string | - | yes |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| domain_example | The organization's domain |
-| project_info_example | The ID of the created prod_gke project |
-| project_info_factory_example | The ID of the created factory project |
+| domain\_example | The organization's domain |
+| project\_info\_example | The ID of the created prod_gke project |
+| project\_info\_factory\_example | The ID of the created factory project |
 
-[^]: (autogen_docs_end)
+[^]: (autogen_docs_end)

examples/simple_project/README.md

@@ -10,21 +10,20 @@ Expected variables:
 
 [^]: (autogen_docs_start)
 
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| admin_email | Admin user email on Gsuite | string | - | yes |
-| billing_account |  | string | - | yes |
-| organization_id |  | string | - | yes |
-| credentials_path |  | string | - | yes |
+| admin\_email | Admin user email on Gsuite | string | - | yes |
+| billing\_account | - | string | - | yes |
+| credentials\_path | Path to a Service Account credentials file with permissions documented in the readme | string | - | yes |
+| organization\_id | - | string | - | yes |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| domain_example | The organization's domain |
-| project_info_example | The ID of the created project |
+| domain\_example | The organization's domain |
+| project\_info\_example | The ID of the created project |
 
-[^]: (autogen_docs_end)
+[^]: (autogen_docs_end)