DEV-2306: Render Components READMEs (#626)

cloudposse · Jul 25, 2024 · e3ba903 · e3ba903
1 parent c7c9a89
commit e3ba903
Show file tree

Hide file tree

Showing 31 changed files with 716 additions and 1,264 deletions.
diff --git a/.github/actions/build-website/action.yml b/.github/actions/build-website/action.yml
@@ -59,6 +59,13 @@ runs:
         make init
         pip install -r scripts/docs-collator/requirements.txt
 
+    - name: "Install terraform-docs"
+      uses: jaxxstorm/action-install-gh-release@v1.12.0
+      with:
+        repo: terraform-docs/terraform-docs
+        tag: v0.18.0
+        cache: enable
+
     - name: "Render Documentation for Terraform Components"
       shell: bash
       run: |

diff --git a/.gitignore b/.gitignore
@@ -12,6 +12,12 @@
 /resources
 /themes
 /tmp
+/docs/generated/components/library
+/docs/generated/modules/library
+/docs/generated/github-actions/library
+/docs/components/library
+/docs/modules/library
+/docs/github-actions/library
 
 /static/css
 /static/js

diff --git a/docs/generated/components/index.mdx → docs/components/index.mdx b/docs/generated/components/index.mdx → docs/components/index.mdx
diff --git a/docs/generated/components/library/aws/_category_.json b/docs/generated/components/library/aws/_category_.json
diff --git a/docs/generated/components/library/aws/account/README.mdx b/docs/generated/components/library/aws/account/README.mdx
diff --git a/docs/generated/github-actions/library/actions/_category_.json b/docs/generated/github-actions/library/actions/_category_.json
diff --git a/docs/generated/github-actions/library/actions/docker-build-push/README.mdx b/docs/generated/github-actions/library/actions/docker-build-push/README.mdx
diff --git a/docs/generated/modules/library/aws/_category_.json b/docs/generated/modules/library/aws/_category_.json