Skip to content

Commit 8999518

Browse files
authored
Add template for customer repos README generation using YAML (#244)
* Add template for README generation using YAML This file serves as a template for generating README files using YAML configuration. It includes various sections such as introduction, usage, and examples, and is designed to be automatically populated with relevant data. * Add customer.yaml for Atmos documentation generation * Update template URL for customer.yaml * Update README.md.simple.gotmpl
1 parent fe4c78d commit 8999518

File tree

2 files changed

+430
-0
lines changed

2 files changed

+430
-0
lines changed

.github/atmos/customer.yaml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
docs:
2+
generate:
3+
readme:
4+
base-dir: .
5+
input:
6+
- "./README.yaml"
7+
- get_support: true
8+
template: "https://raw.githubusercontent.com/cloudposse/.github/refs/heads/add-template-for-repos-without-marketing/README.md.simple.gotmpl"
9+
output: "./README.md"
10+
terraform:
11+
source: .
12+
enabled: false
13+
format: "markdown table"
14+
show_providers: false
15+
show_inputs: true
16+
show_outputs: true
17+
sort_by: "name"
18+
hide_empty: false
19+
indent_level: 2
20+
21+
commands:
22+
- name: readme
23+
steps:
24+
- "atmos docs generate readme"
25+
26+
settings:
27+
telemetry:
28+
enabled: false

0 commit comments

Comments
 (0)