v1.4.0

fix: Improved Links for Developer Onboarding @milldr (#671)

what

• Replace invalid link for Developer Onboarding
• Replace several "legacy" links to latest location for the same content

why

• The "Introduction to Toolset" slides have been replaced with a video
• Avoid using "legacy" links

references

• customer request

feat(DEV-2500): Identity Docs Improvements @milldr (#670)

what

• Improve identity documentation

why

• Incorporate identity feedback from previous PR

references

• #665
• DEV-2500

fix: Preview Env @milldr (#669)

what

• Checkout the preview branch for preview deployments

why

• The workflow runs on pull_request_target

references

• fix previews

♻️ chore(deps): update cloudposse/github-action-atmos-affected-stacks action to v4 @cloudpossebot (#667)

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#699

Datadog Landing page rewrite @Benbentwo (#662)

what

• Rewrite Datadog Landing page and clean it up

why

• Many parts of it are currently broken

references

• https://docs.cloudposse.com/layers/monitoring/datadog/
• https://pr-662.cloudposse-docs.ue2.dev.plat.cloudposse.org/layers/monitoring/datadog/

Fix Steps so that they always start at 1 @osterman (#668)

what

• Ensure the <Steps/> component sets the counter context
• Use the context for <StepNumber/>
• Fix formatting of philips labs setup
• Add missing <Steps/> container where necessary

why

• It was confusing that steps didn't start at 1, if multiple <Steps/> were defined on the page

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