Andrey Kalmykov
04/09/2025, 2:17 PMreadme subcommand we make it an argument, this will allow to have multiple targets. So we could have readme, or component1 or component2 virtually anything as an argumant to docs genrate as well as section in atmos.yaml. The bigger challenge here is how to document it properly so people aren't confused.
3. On defining the input with stack config. The way it currently works: we have a template and a readme.yaaml with a pretty much the same set of keys. So gomplate runs throguh the template and puts the values from the yaml file. In the proposed yaml you list docs and readme and template name sections. They are currntly taken from the atmos.yaml and in your proposaal you suggest to put them into the reame.yaml? Could you please elaborate a little bit what kind of problem you are trying to address?
docs:
readme:
name: "template"
# Canonical GitHub repo
github_repo: "cloudposse-terraform-components/template"
# Short description of this project
description: |-
Description of this component
usage: |-
**Stack Level**: Regional or Test47
Here's an example snippet for how to use this component.
yaml
components:
terraform:
foo:
vars:
enabled: true
include:
- "docs/terraform.md"
tags:
- terraform
- terraform-modules
- aws
- components
- terraform-components
- root
- geodesic
- reference-implementation
- reference-architecture
# Categories of this project
categories:
- terraform-modules/root
- terraform-components
# License of this project
license: "APACHE2"
# Badges to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/cloudposse-terraform-components/template.svg?style=for-the-badge"
url: "https://github.com/cloudposse-terraform-components/template/releases/latest"
- name: "Slack Community"
image: "https://slack.cloudposse.com/for-the-badge.svg"
url: "https://slack.cloudposse.com"
references:
- name: "Cloud Posse Documentation"
description: "Complete documentation for the Cloud Posse solution"
url: "https://docs.cloudposse.com"
- name: "Reference Architectures"
description: "Launch effortlessly with our turnkey reference architectures, built either by your team or ours."
url: "https://cloudposse.com/"
related:
- name: "Cloud Posse Terraform Modules"
description: Our collection of reusable Terraform modules used by our reference architectures.
url: "https://docs.cloudposse.com/modules/"
- name: "Atmos"
description: "Atmos is like docker-compose but for your infrastructure"
url: "https://atmos.tools"
contributors: [] # If included generates contribs
4. atmos generate docs to build all docs options - ok, this can be doneDan Miller (Cloud Posse)
04/09/2025, 2:25 PMErik Osterman (Cloud Posse)
04/09/2025, 3:02 PMreadme subcommand we
readme is not hardcoded, right? That's based on the dynamic configuration in the atmos config.Erik Osterman (Cloud Posse)
04/09/2025, 3:02 PMfoobarAndrey Kalmykov
04/09/2025, 3:05 PMAndrey Kalmykov
04/09/2025, 3:06 PMErik Osterman (Cloud Posse)
04/09/2025, 3:07 PMreadme was not a well-thoughtout command name, because it was arbitrary.Andrey Kalmykov
04/09/2025, 3:08 PMAndrey Kalmykov
04/17/2025, 4:25 AMDan Miller (Cloud Posse)
04/21/2025, 3:25 PMreadme arg for docs.generate to a dynamic value. I believe this is the only change
3. Keep using a list for docs.generate.readme.inputs. This list should support remote file sources, local file sources, and maps of values, which should be merged in orderDan Miller (Cloud Posse)
04/21/2025, 3:27 PMdocs:
generate:
readme:
inputs:
- https://raw.githubusercontent.com/cloudposse-terraform-components/.github/main/templates/default_inputs.yaml
- "./default_tags.yaml"
- name: "kinesis-firehose-stream"
github_repo: "cloudposse-terraform-components/aws-kinesis-firehose-stream"
Option 2:
(require using !include for consistency)
docs:
generate:
readme:
inputs:
- !include https://raw.githubusercontent.com/cloudposse-terraform-components/.github/main/templates/default_inputs.yaml
- !include "./default_tags.yaml"
- name: "kinesis-firehose-stream"
github_repo: "cloudposse-terraform-components/aws-kinesis-firehose-stream"Andrey Kalmykov
04/21/2025, 3:37 PMErik Osterman (Cloud Posse)
04/21/2025, 4:23 PM!includeHaitham
04/21/2025, 10:31 PM!include to the current PRAndrey Kalmykov
04/22/2025, 2:35 PMErik Osterman (Cloud Posse)
04/22/2025, 3:23 PMGues its both for input yaml files and templates? Meanwhile I just do the one #2 change form above list.yes, but the one question lingering in my mind is relative paths
Erik Osterman (Cloud Posse)
04/22/2025, 3:23 PM!include will be differentAndrey Kalmykov
04/22/2025, 3:48 PMAndrey Kalmykov
04/22/2025, 7:11 PMErik Osterman (Cloud Posse)
04/22/2025, 7:17 PMErik Osterman (Cloud Posse)
04/22/2025, 7:17 PMErik Osterman (Cloud Posse)
04/22/2025, 7:17 PMAndrey Kalmykov
04/28/2025, 3:03 PMErik Osterman (Cloud Posse)
04/28/2025, 4:37 PMDan Miller (Cloud Posse)
04/28/2025, 4:51 PMDan Miller (Cloud Posse)
04/29/2025, 1:42 PMERRO failed to render template with datasources: failed to render template: failed to render template docs-generate: template: docs-generate:1:5: executing "docs-generate" at <.name>: map has no entry for key "name"
Yet I have name defined in inputs. Here's a PR that I'm using to test out the command:
https://github.com/cloudposse-terraform-components/aws-kinesis-firehose-stream/pull/9
@Andrey Kalmykov do you have any ideas of what I could be missing?Dan Miller (Cloud Posse)
04/29/2025, 1:51 PMsettings.docs.generate not docs.generate (I was missing settings)Erik Osterman (Cloud Posse)
04/29/2025, 1:52 PMErik Osterman (Cloud Posse)
04/29/2025, 1:52 PMErik Osterman (Cloud Posse)
04/29/2025, 1:52 PMErik Osterman (Cloud Posse)
04/29/2025, 1:52 PMDan Miller (Cloud Posse)
04/29/2025, 1:53 PMErik Osterman (Cloud Posse)
04/29/2025, 1:53 PMAndrey Kalmykov
04/29/2025, 1:56 PMErik Osterman (Cloud Posse)
04/29/2025, 2:29 PMsettings.terminal.Erik Osterman (Cloud Posse)
04/29/2025, 2:29 PMdocs.generate sectionAndrey Kalmykov
04/29/2025, 2:31 PMDan Miller (Cloud Posse)
04/29/2025, 2:42 PMAndrey Kalmykov
05/01/2025, 2:35 PMDan Miller (Cloud Posse)
05/01/2025, 2:45 PMinput:
- "https://www.../README.yaml" # remote file
- "./README.yaml" # local file
- name: "test" # inline mapAndrey Kalmykov
05/05/2025, 4:31 PMDan Miller (Cloud Posse)
05/05/2025, 7:10 PMinput merged in order?Dan Miller (Cloud Posse)
05/05/2025, 7:33 PMDan Miller (Cloud Posse)
05/05/2025, 7:38 PMDan Miller (Cloud Posse)
05/06/2025, 3:35 PMDan Miller (Cloud Posse)
05/06/2025, 3:40 PMErik Osterman (Cloud Posse)
05/06/2025, 3:58 PMErik Osterman (Cloud Posse)
05/06/2025, 3:58 PMDan Miller (Cloud Posse)
05/06/2025, 3:59 PMAndrey Kalmykov
05/07/2025, 4:44 PMAndrey Kalmykov
05/07/2025, 4:44 PMDan Miller (Cloud Posse)
05/07/2025, 5:26 PM