undo README newline changes

gaima8 · gaima8 · commit 9b57199ee277 · 2023-06-13T11:53:28.000+01:00
diff --git a/README.md b/README.md
@@ -9,8 +9,11 @@
 # terraform-github-repository
 
 A [Terraform] module for creating a public or private repository on [Github].
+
 **_This module supports Terraform v1.x and is compatible with the Official Terraform GitHub Provider v4.20 and above from `integrations/github`._**
+
 **Attention: This module is incompatible with the Hashicorp GitHub Provider! The latest version of this module supporting `hashicorp/github` provider is `~> 0.10.0`**
+
 ** Note: Versions 5.3.0, 5.4.0, and 5.5.0 of the Terraform Github Provider have broken branch protections support and should not be used.**
 
 
@@ -59,22 +62,26 @@ rollouts** and **rollbacks**. It's a comprehensive, ready-to-use blueprint
 maintained by our team of platform engineering experts and saves
 companies such as yours tons of time by building on top of a pre-configured
 solution instead of building and maintaining it yourself.
+
 For details please see [https://mineiros.io/github-as-code][github-as-code].
 
 ## Module Features
 
 In contrast to the plain `github_repository` resource this module enables various other
 features like Branch Protection or Collaborator Management.
+
 - **Default Security Settings**:
   This module creates a `private` repository by default,
   Deploy keys are `read-only` by default
+
 - **Standard Repository Features**:
   Setting basic Metadata,
   Merge Strategy,
   Auto Init,
   License Template,
   Gitignore Template,
   Template Repository
+
 - **Extended Repository Features**:
   Branches,
   Branch Protection,
@@ -85,6 +92,7 @@ features like Branch Protection or Collaborator Management.
   Deploy Keys,
   Projects,
   Repository Webhooks
+
 - _Features not yet implemented_:
   Project Columns support,
   Actions,
@@ -93,10 +101,12 @@ features like Branch Protection or Collaborator Management.
 ## Getting Started
 
 Most basic usage creating a new private github repository.
+
 ```hcl
 module "repository" {
   source  = "mineiros-io/repository/github"
   version = "~> 0.18.0"
+
   name               = "terraform-github-repository"
   license_template   = "apache-2.0"
   gitignore_template = "Terraform"
@@ -607,9 +617,12 @@ This is due to some terraform limitation and we will update the module once terr
 - [**`branch_protections_v4`**](#var-branch_protections_v4): *(Optional `list(branch_protection_v4)`)*<a name="var-branch_protections_v4"></a>
 
   This resource allows you to configure v4 branch protection for repositories in your organization.
+
   Each element in the list is a branch to be protected and the value the corresponding to the desired configuration for the branch.
+
   When applied, the branch will be protected from forced pushes and deletion.
   Additional constraints, such as required status checks or restrictions on users and teams, can also be configured.
+
   **_NOTE:_** May conflict with v3 branch protections if used for the same branch.
 
   Default is `[]`.
@@ -876,9 +889,13 @@ This is due to some terraform limitation and we will update the module once terr
 - [**`plaintext_secrets`**](#var-plaintext_secrets): *(Optional `map(string)`)*<a name="var-plaintext_secrets"></a>
 
   This map allows you to create and manage secrets for repositories in your organization.
+
   Each element in the map is considered a secret to be managed, being the key map the secret name and the value the corresponding secret in plain text:
+
   When applied, a secret with the given key and value will be created in the repositories.
+
   The value of the secrets must be given in plain text, GitHub provider is in charge of encrypting it.
+
   **Attention:** You should treat state as sensitive always. It is also advised that you do not store plaintext values in your code but rather populate the encrypted_value using fields from a resource, data source or variable as, while encrypted in state, these will be easily accessible in your code. See below for an example of this abstraction.
 
   Default is `{}`.
@@ -895,7 +912,9 @@ This is due to some terraform limitation and we will update the module once terr
 - [**`encrypted_secrets`**](#var-encrypted_secrets): *(Optional `map(string)`)*<a name="var-encrypted_secrets"></a>
 
   This map allows you to create and manage encrypted secrets for repositories in your organization.
+
   Each element in the map is considered a secret to be managed, being the key map the secret name and the value the corresponding encrypted value of the secret using the Github public key in Base64 format.b
+
   When applied, a secret with the given key and value will be created in the repositories.
 
   Default is `{}`.
@@ -1044,7 +1063,9 @@ The following attributes are exported by the module:
 ## Module Versioning
 
 This Module follows the principles of [Semantic Versioning (SemVer)].
+
 Given a version number `MAJOR.MINOR.PATCH`, we increment the:
+
 1. `MAJOR` version when we make incompatible changes,
 2. `MINOR` version when we add functionality in a backwards compatible manner, and
 3. `PATCH` version when we make backwards compatible bug fixes.
@@ -1058,8 +1079,10 @@ Given a version number `MAJOR.MINOR.PATCH`, we increment the:
 
 [Mineiros][homepage] is a remote-first company headquartered in Berlin, Germany
 that solves development, automation and security challenges in cloud infrastructure.
+
 Our vision is to massively reduce time and overhead for teams to manage and
 deploy production-grade and secure cloud infrastructure.
+
 We offer commercial support for all of our modules and encourage you to reach out
 if you have any questions or need help. Feel free to email us at [hello@mineiros.io] or join our
 [Community Slack channel][slack].
@@ -1081,8 +1104,10 @@ Run `make help` to see details on each available target.
 ## License
 
 [![license][badge-license]][apache20]
+
 This module is licensed under the Apache License Version 2.0, January 2004.
 Please see [LICENSE] for full details.
+
 Copyright &copy; 2020-2022 [Mineiros GmbH][homepage]
 
 
diff --git a/README.tfdoc.hcl b/README.tfdoc.hcl
@@ -38,8 +38,11 @@ section {
   toc     = true
   content = <<-END
     A [Terraform] module for creating a public or private repository on [Github].
+
     **_This module supports Terraform v1.x and is compatible with the Official Terraform GitHub Provider v4.20 and above from `integrations/github`._**
+
     **Attention: This module is incompatible with the Hashicorp GitHub Provider! The latest version of this module supporting `hashicorp/github` provider is `~> 0.10.0`**
+
     ** Note: Versions 5.3.0, 5.4.0, and 5.5.0 of the Terraform Github Provider have broken branch protections support and should not be used.**
   END
 
@@ -57,6 +60,7 @@ section {
       maintained by our team of platform engineering experts and saves
       companies such as yours tons of time by building on top of a pre-configured
       solution instead of building and maintaining it yourself.
+
       For details please see [https://mineiros.io/github-as-code][github-as-code].
     END
   }
@@ -66,16 +70,19 @@ section {
     content = <<-END
       In contrast to the plain `github_repository` resource this module enables various other
       features like Branch Protection or Collaborator Management.
+
       - **Default Security Settings**:
         This module creates a `private` repository by default,
         Deploy keys are `read-only` by default
+
       - **Standard Repository Features**:
         Setting basic Metadata,
         Merge Strategy,
         Auto Init,
         License Template,
         Gitignore Template,
         Template Repository
+
       - **Extended Repository Features**:
         Branches,
         Branch Protection,
@@ -86,6 +93,7 @@ section {
         Deploy Keys,
         Projects,
         Repository Webhooks
+
       - _Features not yet implemented_:
         Project Columns support,
         Actions,
@@ -97,10 +105,12 @@ section {
     title   = "Getting Started"
     content = <<-END
       Most basic usage creating a new private github repository.
+
       ```hcl
       module "repository" {
         source  = "mineiros-io/repository/github"
         version = "~> 0.18.0"
+
         name               = "terraform-github-repository"
         license_template   = "apache-2.0"
         gitignore_template = "Terraform"
@@ -786,9 +796,12 @@ section {
           default     = []
           description = <<-END
             This resource allows you to configure v4 branch protection for repositories in your organization.
+
             Each element in the list is a branch to be protected and the value the corresponding to the desired configuration for the branch.
+
             When applied, the branch will be protected from forced pushes and deletion.
             Additional constraints, such as required status checks or restrictions on users and teams, can also be configured.
+
             **_NOTE:_** May conflict with v3 branch protections if used for the same branch.
           END
 
@@ -1162,9 +1175,13 @@ section {
           default     = {}
           description = <<-END
             This map allows you to create and manage secrets for repositories in your organization.
+
             Each element in the map is considered a secret to be managed, being the key map the secret name and the value the corresponding secret in plain text:
+
             When applied, a secret with the given key and value will be created in the repositories.
+
             The value of the secrets must be given in plain text, GitHub provider is in charge of encrypting it.
+
             **Attention:** You should treat state as sensitive always. It is also advised that you do not store plaintext values in your code but rather populate the encrypted_value using fields from a resource, data source or variable as, while encrypted in state, these will be easily accessible in your code. See below for an example of this abstraction.
           END
 
@@ -1181,7 +1198,9 @@ section {
           default     = {}
           description = <<-END
             This map allows you to create and manage encrypted secrets for repositories in your organization.
+
             Each element in the map is considered a secret to be managed, being the key map the secret name and the value the corresponding encrypted value of the secret using the Github public key in Base64 format.b
+
             When applied, a secret with the given key and value will be created in the repositories.
           END
 
@@ -1401,7 +1420,9 @@ section {
     title   = "Module Versioning"
     content = <<-END
       This Module follows the principles of [Semantic Versioning (SemVer)].
+
       Given a version number `MAJOR.MINOR.PATCH`, we increment the:
+
       1. `MAJOR` version when we make incompatible changes,
       2. `MINOR` version when we add functionality in a backwards compatible manner, and
       3. `PATCH` version when we make backwards compatible bug fixes.
@@ -1421,8 +1442,10 @@ section {
     content = <<-END
       [Mineiros][homepage] is a remote-first company headquartered in Berlin, Germany
       that solves development, automation and security challenges in cloud infrastructure.
+
       Our vision is to massively reduce time and overhead for teams to manage and
       deploy production-grade and secure cloud infrastructure.
+
       We offer commercial support for all of our modules and encourage you to reach out
       if you have any questions or need help. Feel free to email us at [hello@mineiros.io] or join our
       [Community Slack channel][slack].
@@ -1456,8 +1479,10 @@ section {
     title   = "License"
     content = <<-END
       [![license][badge-license]][apache20]
+
       This module is licensed under the Apache License Version 2.0, January 2004.
       Please see [LICENSE] for full details.
+
       Copyright &copy; 2020-2022 [Mineiros GmbH][homepage]
     END
   }
@@ -1557,4 +1582,4 @@ references {
   ref "contribution guidelines" {
     value = "https://github.com/mineiros-io/terraform-github-repository/blob/main/CONTRIBUTING.md"
   }
-}
+}
