From 79e1036f5b51be80ba41a3518b97c9f7f3c56733 Mon Sep 17 00:00:00 2001 From: Soren Martius Date: Mon, 11 Jul 2022 16:45:35 +0200 Subject: [PATCH] docs: add github as code section --- README.md | 13 +++++++++++++ README.tfdoc.hcl | 17 +++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/README.md b/README.md index fd94bcf..3ef0033 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ _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) @@ -931,6 +932,17 @@ 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 @@ -976,6 +988,7 @@ Copyright © 2020-2022 [Mineiros GmbH][homepage] [`github_repository_project`]: https://www.terraform.io/docs/providers/github/r/repository_project.html#attributes-reference [`github_repository_autolink_reference`]: https://www.terraform.io/docs/providers/github/r/repository_autolink_reference.html#attributes-reference [homepage]: https://mineiros.io/?ref=terraform-github-repository +[github-as-code]: https://mineiros.io/github-as-code?ref=terraform-github-repository [hello@mineiros.io]: mailto:hello@mineiros.io [badge-build]: https://github.com/mineiros-io/terraform-github-repository/workflows/CI/CD%20Pipeline/badge.svg [badge-semver]: https://img.shields.io/github/v/tag/mineiros-io/terraform-github-repository.svg?label=latest&sort=semver diff --git a/README.tfdoc.hcl b/README.tfdoc.hcl index 20d27c4..6d40865 100644 --- a/README.tfdoc.hcl +++ b/README.tfdoc.hcl @@ -1239,6 +1239,20 @@ 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 @@ -1312,6 +1326,9 @@ references { ref "homepage" { value = "https://mineiros.io/?ref=terraform-github-repository" } + ref "github-as-code" { + value = "https://mineiros.io/github-as-code?ref=terraform-github-repository" + } ref "hello@mineiros.io" { value = "mailto:hello@mineiros.io" }