Skip to content

Commit c0fb8e1

Browse files
Merge pull request #130 from mineiros-io/soerenmartius/commercial-note
docs: move commercial note to the top of the repository
2 parents fd18262 + 46f5932 commit c0fb8e1

File tree

2 files changed

+36
-26
lines changed

2 files changed

+36
-26
lines changed

README.md

+17-12
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ A [Terraform] module for creating a public or private repository on [Github].
1717
_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._
1818

1919

20+
- [GitHub as Code](#github-as-code)
2021
- [Module Features](#module-features)
2122
- [Getting Started](#getting-started)
2223
- [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
4041
- [Terraform Github Provider Documentation](#terraform-github-provider-documentation)
4142
- [Module Versioning](#module-versioning)
4243
- [Backwards compatibility in `0.0.z` and `0.y.z` version](#backwards-compatibility-in-00z-and-0yz-version)
43-
- [GitHub as Code](#github-as-code)
4444
- [About Mineiros](#about-mineiros)
4545
- [Reporting Issues](#reporting-issues)
4646
- [Contributing](#contributing)
4747
- [Makefile Targets](#makefile-targets)
4848
- [License](#license)
4949

50+
## GitHub as Code
51+
52+
[GitHub as Code][github-as-code] is a commercial solution built on top of
53+
our open-source Terraform modules for GitHub. It helps our customers to
54+
manage their GitHub organization more efficiently by enabling anyone in
55+
their organization to **self-service** manage **on- and offboarding of users**,
56+
**repositories**, and settings such as **branch protections**, **secrets**, and more
57+
through code. GitHub as Code comes with **pre-configured GitHub Actions
58+
pipelines** for **change pre-view in Pull Requests**, **fully automated
59+
rollouts** and **rollbacks**. It's a comprehensive, ready-to-use blueprint
60+
maintained by our team of platform engineering experts and saves
61+
companies such as yours tons of time by building on top of a pre-configured
62+
solution instead of building and maintaining it yourself.
63+
64+
For details please see [https://mineiros.io/github-as-code][github-as-code].
65+
5066
## Module Features
5167

5268
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:
932948
- Backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
933949
- Backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)
934950

935-
## GitHub as Code
936-
937-
[GitHub as Code][github-as-code] is a commercial solution built on top of
938-
our open-source Terraform modules for GitHub. It helps our customers to
939-
manage their GitHub organization more efficiently by enabling anyone in
940-
their organization to self-service manage on- and offboarding of users,
941-
repositories, and settings such as branch protections, secrets, and more
942-
through code.
943-
944-
For details please see [https://mineiros.io/github-as-code][github-as-code].
945-
946951
## About Mineiros
947952

948953
[Mineiros][homepage] is a remote-first company headquartered in Berlin, Germany

README.tfdoc.hcl

+19-14
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,25 @@ section {
4646
_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._
4747
END
4848

49+
section {
50+
title = "GitHub as Code"
51+
content = <<-END
52+
[GitHub as Code][github-as-code] is a commercial solution built on top of
53+
our open-source Terraform modules for GitHub. It helps our customers to
54+
manage their GitHub organization more efficiently by enabling anyone in
55+
their organization to **self-service** manage **on- and offboarding of users**,
56+
**repositories**, and settings such as **branch protections**, **secrets**, and more
57+
through code. GitHub as Code comes with **pre-configured GitHub Actions
58+
pipelines** for **change pre-view in Pull Requests**, **fully automated
59+
rollouts** and **rollbacks**. It's a comprehensive, ready-to-use blueprint
60+
maintained by our team of platform engineering experts and saves
61+
companies such as yours tons of time by building on top of a pre-configured
62+
solution instead of building and maintaining it yourself.
63+
64+
For details please see [https://mineiros.io/github-as-code][github-as-code].
65+
END
66+
}
67+
4968
section {
5069
title = "Module Features"
5170
content = <<-END
@@ -1239,20 +1258,6 @@ section {
12391258
}
12401259
}
12411260

1242-
section {
1243-
title = "GitHub as Code"
1244-
content = <<-END
1245-
[GitHub as Code][github-as-code] is a commercial solution built on top of
1246-
our open-source Terraform modules for GitHub. It helps our customers to
1247-
manage their GitHub organization more efficiently by enabling anyone in
1248-
their organization to self-service manage on- and offboarding of users,
1249-
repositories, and settings such as branch protections, secrets, and more
1250-
through code.
1251-
1252-
For details please see [https://mineiros.io/github-as-code][github-as-code].
1253-
END
1254-
}
1255-
12561261
section {
12571262
title = "About Mineiros"
12581263
content = <<-END

0 commit comments

Comments
 (0)