Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Github As Code section to docs #126

Merged
merged 1 commit into from
Jul 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
[[email protected]]: mailto:[email protected]
[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
Expand Down
17 changes: 17 additions & 0 deletions README.tfdoc.hcl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 "[email protected]" {
value = "mailto:[email protected]"
}
Expand Down