Merge pull request #130 from mineiros-io/soerenmartius/commercial-note

docs: move commercial note to the top of the repository
mineiros-io · Sep 20, 2022 · c0fb8e1 · c0fb8e1
2 parents fd18262 + 46f5932
commit c0fb8e1
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,7 @@ A [Terraform] module for creating a public or private repository on [Github].
 _Security related notice: Versions 4.7.0, 4.8.0, 4.9.0 and 4.9.1 of the Terraform Github Provider are deny-listed in version constraints as a regression introduced in 4.7.0 and fixed in 4.9.2 creates public repositories from templates even if visibility is set to private._
 
 
+- [GitHub as Code](#github-as-code)
 - [Module Features](#module-features)
 - [Getting Started](#getting-started)
 - [Module Argument Reference](#module-argument-reference)
@@ -40,13 +41,28 @@ _Security related notice: Versions 4.7.0, 4.8.0, 4.9.0 and 4.9.1 of the Terrafor
   - [Terraform Github Provider Documentation](#terraform-github-provider-documentation)
 - [Module Versioning](#module-versioning)
   - [Backwards compatibility in `0.0.z` and `0.y.z` version](#backwards-compatibility-in-00z-and-0yz-version)
-- [GitHub as Code](#github-as-code)
 - [About Mineiros](#about-mineiros)
 - [Reporting Issues](#reporting-issues)
 - [Contributing](#contributing)
 - [Makefile Targets](#makefile-targets)
 - [License](#license)
 
+## GitHub as Code
+
+[GitHub as Code][github-as-code] is a commercial solution built on top of
+our open-source Terraform modules for GitHub. It helps our customers to
+manage their GitHub organization more efficiently by enabling anyone in
+their organization to **self-service** manage **on- and offboarding of users**,
+**repositories**, and settings such as **branch protections**, **secrets**, and more
+through code. GitHub as Code comes with **pre-configured GitHub Actions
+pipelines** for **change pre-view in Pull Requests**, **fully automated
+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
@@ -932,17 +948,6 @@ Given a version number `MAJOR.MINOR.PATCH`, we increment the:
 - Backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
 - Backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)
 
-## GitHub as Code
-
-[GitHub as Code][github-as-code] is a commercial solution built on top of
-our open-source Terraform modules for GitHub. It helps our customers to
-manage their GitHub organization more efficiently by enabling anyone in
-their organization to self-service manage on- and offboarding of users,
-repositories, and settings such as branch protections, secrets, and more
-through code.
-
-For details please see [https://mineiros.io/github-as-code][github-as-code].
-
 ## About Mineiros
 
 [Mineiros][homepage] is a remote-first company headquartered in Berlin, Germany

diff --git a/README.tfdoc.hcl b/README.tfdoc.hcl
@@ -46,6 +46,25 @@ section {
     _Security related notice: Versions 4.7.0, 4.8.0, 4.9.0 and 4.9.1 of the Terraform Github Provider are deny-listed in version constraints as a regression introduced in 4.7.0 and fixed in 4.9.2 creates public repositories from templates even if visibility is set to private._
   END
 
+  section {
+    title   = "GitHub as Code"
+    content = <<-END
+      [GitHub as Code][github-as-code] is a commercial solution built on top of
+      our open-source Terraform modules for GitHub. It helps our customers to
+      manage their GitHub organization more efficiently by enabling anyone in
+      their organization to **self-service** manage **on- and offboarding of users**,
+      **repositories**, and settings such as **branch protections**, **secrets**, and more
+      through code. GitHub as Code comes with **pre-configured GitHub Actions
+      pipelines** for **change pre-view in Pull Requests**, **fully automated
+      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].
+    END
+  }
+
   section {
     title   = "Module Features"
     content = <<-END
@@ -1239,20 +1258,6 @@ section {
     }
   }
 
-  section {
-    title   = "GitHub as Code"
-    content = <<-END
-      [GitHub as Code][github-as-code] is a commercial solution built on top of
-      our open-source Terraform modules for GitHub. It helps our customers to
-      manage their GitHub organization more efficiently by enabling anyone in
-      their organization to self-service manage on- and offboarding of users,
-      repositories, and settings such as branch protections, secrets, and more
-      through code.
-
-      For details please see [https://mineiros.io/github-as-code][github-as-code].
-    END
-  }
-
   section {
     title   = "About Mineiros"
     content = <<-END