v1.3.0

feat: Improve Identity Documentation @milldr (#665)

what

• Updated identity documentation
• Added mermaid diagrams

why

• Identity is a common point of confusing. We'd like to improve documentation
• Lucid is no longer supported internally. Instead we use mermaid

references

• customer

v1.2.0

Enhance Mermaid Diagrams and Definition Lists @osterman (#666)

what

• Improve formatting for mermaid diagrams
• Support icons in mermaid diagrams
• Automatic link terms in definition lists and support smooth scrolling to terms
• Update formatting for tutorials

why

• We're moving to use more mermaid diagrams because they are easier to main and searchable with algolia
• Using icons makes diagrams easier to digest and comparable to mainstream diagraming tools
• When there are a lot of definitions on a page, it's helpful to be able to link to a specific one

demo

v1.1.0

DEV-2485: `AtmosWorkflow` Component @milldr (#660)

what

• Created AtmosWorkflow docs component

why

• Replace all atmos workflow calls with tabs for either the workflows options or the native atmos terraform commands

references

• DEV-2485

usage

import AtmosWorkflow from '@site/src/components/AtmosWorkflow';
...

<AtmosWorkflow workflow="deploy/organization" fileName="accounts" />
<AtmosWorkflow workflow="deploy/organization" fileName="accounts" stack="foo"/>

♻️ Generate _all_ Atmos Workflows @cloudpossebot (#661)

What

This pull request was created by the 🚀 Generate Examples workflow in the cloudposse/refarch-scaffold repository. This PR updates this documentation repo with the latest configuration for the Cloud Posse reference architecture.

Why

This documentation repo is used for reference purposes and should have the latest configuration.

References

Internal PR: cloudposse/refarch-scaffold#698

DEV-2439: Broken Links @milldr (#652)

what

• Fix all broken links
• Enforce links to resolve for docusarus

why

• Fix all broken links in and enforce valid links going forward

references

• DEV-2439

♻️ DEV-2486: Export Workflows as Snippets @cloudpossebot (#653)

What

This pull request was created by the 🚀 Generate Examples workflow in the cloudposse/refarch-scaffold repository. This PR updates this documentation repo with the latest configuration for the Cloud Posse reference architecture.

Why

This documentation repo is used for reference purposes and should have the latest configuration.

References

Internal PR: cloudposse/refarch-scaffold#697

v1.0.5

🚀 Enhancements

Fix typo in foundation.mdx @StewartThomson (#650)

what

• Describe high-level what changed as a result of these commits (i.e. what do these changes mean)
• Use bullet points to be concise and to the point

why

• Provide the justifications for the changes (e.g. business case)
• Describe why these changes were made (e.g. why do these commits fix the problem)
• Use bullet points to be concise and to the point

references

• Link to any supporting GitHub issues or helpful documentation to add some context (e.g. stackoverflow)
• Link to any supporting Jira issues or documentation
• Use closes #123, if this PR closes a GitHub issue #123

v1.0.4

🚀 Enhancements

Fix Mobile Responsiveness / Add Icons to Mermaid Diagrams @osterman (#651)

what

• Fix mobile responsiveness
• Make callouts clickable
• Support iconify icons, or AWS icons in mermaid diagrams. (Swizzled the Mermaid component)
• Redirect /reference-architecture to /learn

why

• Improve UX

v1.0.3

🚀 Enhancements

DEV-2295: Additional Post Release Corrections @milldr (#649)

what

• Update S3 sync path and exclude handoff assets
• Add title pages for components and each module type

why

• Dont delete handoff videos created by another repo
• Better title card summaries

references

• DEV-2295

v1.0.2

🚀 Enhancements

DEV-2295: Post Release Corrections @milldr (#648)

what

• Fixed the README template for rendering GitHub Actions and Terraform Modules

why

• A commit before the staging changes was merged into these templates and broke the build
• Reverted the change

references

• DEV-2295

[09-08-2024 14:11:50] WARNING {"time":"2024-08-09T14:11:50.042188-04:00","level":"ERROR","msg":"","err":"renderTemplate: failed to render template /Users/danielmiller/Documents/dev/cloudposse/docs/scripts/docs-collator/templates/modules/readme.md: template: /Users/danielmiller/Documents/dev/cloudposse/docs/scripts/docs-collator/templates/modules/readme.md:79:4: executing \"/Users/danielmiller/Documents/dev/cloudposse/docs/scripts/docs-collator/templates/modules/readme.md\" at <include \"includes\" (printf \"%s/%s\" $fullModuleName $file)>: error calling include: undefined datasource 'includes': %!w(<nil>)"}
make: *** [/Users/danielmiller/Documents/dev/cloudposse/docs/build-harness/modules/readme/Makefile:69: readme/build] Error 1

v1.0.1

🚀 Enhancements

DEV-2295: Minor Post-Deployment Corrections @milldr (#647)

what

• Use production environment
• Remove deprecated docs
• Added algolia reindex

why

• Minor corrections to release

references

• DEV-2295

v1.0.0

Public Reference Architecture Release @milldr (#646)

what

• Redesigne the entire documentation site
• Updated the release workflows

why

We are making all documentation public! As such we migratated all of our documentation to cloudposse/docs and reorganize many documentation pages, to improve the learning journey.

references

DEV-2295

Bugfix: Docs - `module` and `actions` rendering @Benbentwo (#614)

what

• Attempt to fix Modules / GHA section of our docs site.

Why

• We need those docs and somehow our pipeline stopped rendering them.

References

• cloudposse/build-harness#100
• cloudposse/build-harness#368
• cloudposse/.github#29

Update automated testing instructions @osterman (#610)

what

• Remove recommendation to run github/init

why

• No longer supported and it will be removed

v0.88.0

Components Rendering: Support nested readmes @Benbentwo (#609)

what

• Update Component Renderer to support other Markdown files, such as docs/some-doc.md
  • ignores Changelog, since that is added to the README.md specifically (at the bottom)
  • supports copying images to keep local references

why

• Components can have a docs folder, this is a common pattern. This is a pattern we will be implementing in terraform-aws-components
• This pattern will continue as we move components to the cloudposse-components GitHub organization.

feat: Add ECR Remote Cache recommendation @korenyoni (#607)

what

• Add ECR Remote Cache recommendation

why

• Recommend using ECR as a remote cache as per our recommendation in cloudposse/github-action-docker-build-push

references

• cloudposse/github-action-docker-build-push#61
• cloudposse-examples/app-on-eks-with-argocd#32

Warn about input errors with object inputs, remove DNS section @Nuru (#606)

what

• Warn about input errors being silently ignored with object inputs
• Remove DNS section from Terraform Best Practices
• Incorporate some changes from #584 and update some others, thanks @whyevenquestion1t
• Enhance site builder to render README.yaml of sub-modules when present

why

• Non-obvious behavior can lead to serious consequences
• Recommendations about DNS configuration are not relevant to Terraform
• Supersedes and closes #584, which is not completely ready to merge and is nearly a year old
• Submodule README.md is expected to be plain. If it is generated by README.yaml, then parse it like we do for top-level modules so we do not get the extra stuff that breaks Docusaurus.

Cleanup @Nuru (#605)

what

• Documentation updates
• Fix some broken links
• Update caniuse-lite to current version
• Update .gitignore to ignore generated content

why

• Respond to reviewer comments (not necessarily logged in this PR)
• Keep site working properly

references

• https://github.com/browserslist/update-db#why-you-need-to-call-it-regularly