Skip to content

Commit 0b39a8b

Browse files
committed
docs: add github as code section
1 parent 943b0a9 commit 0b39a8b

File tree

2 files changed

+33
-1
lines changed

2 files changed

+33
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ A [Terraform] module that offers a more convenient and tested way to provision a
2929
- [Module Versioning](#module-versioning)
3030
- [Backwards compatibility in `0.0.z` and `0.y.z` version](#backwards-compatibility-in-00z-and-0yz-version)
3131
- [About Mineiros](#about-mineiros)
32+
- [About Mineiros](#about-mineiros)
3233
- [Reporting Issues](#reporting-issues)
3334
- [Contributing](#contributing)
3435
- [Makefile Targets](#makefile-targets)
@@ -174,7 +175,7 @@ See [variables.tf] and [examples/] for details and use-cases.
174175

175176
### Module Configuration
176177

177-
- [**`module_depends_on`**](#var-module_depends_on): *(Optional `list(any)`)*<a name="var-module_depends_on"></a>
178+
- [**`module_depends_on`**](#var-module_depends_on): *(Optional `list(object)`)*<a name="var-module_depends_on"></a>
178179

179180
A list of dependencies. Any object can be _assigned_ to this list to define a hidden external dependency.
180181

@@ -247,6 +248,18 @@ We offer commercial support for all of our modules and encourage you to reach ou
247248
if you have any questions or need help. Feel free to email us at [hello@mineiros.io] or join our
248249
[Community Slack channel][slack].
249250

251+
## About Mineiros
252+
253+
[Mineiros][homepage] is a remote-first company headquartered in Berlin, Germany
254+
that solves development, automation and security challenges in cloud infrastructure.
255+
256+
Our vision is to massively reduce time and overhead for teams to manage and
257+
deploy production-grade and secure cloud infrastructure.
258+
259+
We offer commercial support for all of our modules and encourage you to reach out
260+
if you have any questions or need help. Feel free to email us at [hello@mineiros.io] or join our
261+
[Community Slack channel][slack].
262+
250263
## Reporting Issues
251264

252265
We use GitHub [Issues] to track community reported issues and missing features.
@@ -274,6 +287,7 @@ Copyright &copy; 2020-2022 [Mineiros GmbH][homepage]
274287
<!-- References -->
275288

276289
[homepage]: https://mineiros.io/?ref=terraform-github-team
290+
[github-as-code]: https://mineiros.io/github-as-code?ref=terraform-github-repository
277291
[hello@mineiros.io]: mailto:hello@mineiros.io
278292
[badge-build]: https://github.com/mineiros-io/terraform-github-team/workflows/CI/CD%20Pipeline/badge.svg
279293
[badge-semver]: https://img.shields.io/github/v/tag/mineiros-io/terraform-github-team.svg?label=latest&sort=semver

README.tfdoc.hcl

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,21 @@ section {
345345
END
346346
}
347347

348+
section {
349+
title = "About Mineiros"
350+
content = <<-END
351+
[Mineiros][homepage] is a remote-first company headquartered in Berlin, Germany
352+
that solves development, automation and security challenges in cloud infrastructure.
353+
354+
Our vision is to massively reduce time and overhead for teams to manage and
355+
deploy production-grade and secure cloud infrastructure.
356+
357+
We offer commercial support for all of our modules and encourage you to reach out
358+
if you have any questions or need help. Feel free to email us at [hello@mineiros.io] or join our
359+
[Community Slack channel][slack].
360+
END
361+
}
362+
348363
section {
349364
title = "Reporting Issues"
350365
content = <<-END
@@ -385,6 +400,9 @@ references {
385400
ref "homepage" {
386401
value = "https://mineiros.io/?ref=terraform-github-team"
387402
}
403+
ref "github-as-code" {
404+
value = "https://mineiros.io/github-as-code?ref=terraform-github-repository"
405+
}
388406
ref "hello@mineiros.io" {
389407
value = "mailto:hello@mineiros.io"
390408
}

0 commit comments

Comments
 (0)