-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
80 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
{{- defineDatasource "config" .Env.README_YAML -}} | ||
{{- defineDatasource "includes" (env.Getenv "README_INCLUDES" | default "./") -}} | ||
{{- $deprecated := has (ds "config") "deprecated" }} | ||
|
||
|
||
<!-- markdownlint-disable --> | ||
{{ if $deprecated -}} | ||
# (deprecated) {{(ds "config").name}} | ||
{{- else }} | ||
# {{(ds "config").name}} <a href="{{ $homepage }}"><img align="right" src="{{ $logo }}" width="150" /></a> | ||
{{ end }} | ||
{{- if $deprecated -}}<img src="https://img.shields.io/badge/lifecycle-deprecated-critical?style=for-the-badge" alt="Deprecated"/>{{- end -}} | ||
<!-- markdownlint-restore --> | ||
|
||
<!-- | ||
|
||
|
||
|
||
|
||
** DO NOT EDIT THIS FILE | ||
** | ||
** This file was automatically generated by the `cloudposse/build-harness`. | ||
** 1) Make all changes to `README.yaml` | ||
** 2) Run `make init` (you only need to do this once) | ||
** 3) Run`make readme` to rebuild this file. | ||
** | ||
** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) | ||
** | ||
|
||
|
||
|
||
|
||
|
||
--> | ||
{{- if $deprecated }} | ||
## Deprecated | ||
|
||
{{ if has (ds "config").deprecated "notice" }} | ||
{{- (ds "config").deprecated.notice }} | ||
{{- else }} | ||
> [!IMPORTANT] | ||
> This module is no longer actively maintained | ||
{{- end }} | ||
{{- end }} | ||
|
||
{{ if has (ds "config") "description" }} | ||
{{(ds "config").description }} | ||
{{- end }} | ||
{{- else }} | ||
{{- if has (ds "config") "description" }} | ||
{{ (ds "config").description }} | ||
{{- end }} | ||
{{- end }} | ||
|
||
{{ if has (ds "config") "introduction" }} | ||
## Introduction | ||
|
||
{{ (ds "config").introduction }} | ||
{{ end }} | ||
|
||
{{ if has (ds "config") "usage" }} | ||
## Usage | ||
|
||
{{ if not $deprecated -}} | ||
{{ if has (ds "config") "quickstart" -}} | ||
## Quick Start | ||
|
||
{{ (ds "config").quickstart -}} | ||
{{ end }} | ||
|
||
{{- if has (ds "config") "examples" }} | ||
## Examples | ||
|
||
{{ (ds "config").examples }} | ||
{{ end }} | ||
|
||
<!-- prettier-ignore-start --> | ||
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> | ||
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> | ||
<!-- prettier-ignore-end --> |