Skip to content

Commit fd18262

Browse files
authored
Merge pull request mineiros-io#126 from mineiros-io/soerenmartius/add-github-as-code-section
Add Github As Code section to docs
2 parents 9f3f601 + 79e1036 commit fd18262

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ _Security related notice: Versions 4.7.0, 4.8.0, 4.9.0 and 4.9.1 of the Terrafor
4040
- [Terraform Github Provider Documentation](#terraform-github-provider-documentation)
4141
- [Module Versioning](#module-versioning)
4242
- [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)
4344
- [About Mineiros](#about-mineiros)
4445
- [Reporting Issues](#reporting-issues)
4546
- [Contributing](#contributing)
@@ -931,6 +932,17 @@ Given a version number `MAJOR.MINOR.PATCH`, we increment the:
931932
- Backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
932933
- Backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)
933934

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+
934946
## About Mineiros
935947

936948
[Mineiros][homepage] is a remote-first company headquartered in Berlin, Germany
@@ -976,6 +988,7 @@ Copyright © 2020-2022 [Mineiros GmbH][homepage]
976988
[`github_repository_project`]: https://www.terraform.io/docs/providers/github/r/repository_project.html#attributes-reference
977989
[`github_repository_autolink_reference`]: https://www.terraform.io/docs/providers/github/r/repository_autolink_reference.html#attributes-reference
978990
[homepage]: https://mineiros.io/?ref=terraform-github-repository
991+
[github-as-code]: https://mineiros.io/github-as-code?ref=terraform-github-repository
979992
[hello@mineiros.io]: mailto:hello@mineiros.io
980993
[badge-build]: https://github.com/mineiros-io/terraform-github-repository/workflows/CI/CD%20Pipeline/badge.svg
981994
[badge-semver]: https://img.shields.io/github/v/tag/mineiros-io/terraform-github-repository.svg?label=latest&sort=semver

README.tfdoc.hcl

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,6 +1239,20 @@ section {
12391239
}
12401240
}
12411241

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+
12421256
section {
12431257
title = "About Mineiros"
12441258
content = <<-END
@@ -1312,6 +1326,9 @@ references {
13121326
ref "homepage" {
13131327
value = "https://mineiros.io/?ref=terraform-github-repository"
13141328
}
1329+
ref "github-as-code" {
1330+
value = "https://mineiros.io/github-as-code?ref=terraform-github-repository"
1331+
}
13151332
ref "hello@mineiros.io" {
13161333
value = "mailto:hello@mineiros.io"
13171334
}

0 commit comments

Comments
 (0)