Releases: cloudposse/docs
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
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
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
![image](https://private-user-images.githubusercontent.com/52489/360218037-429482f6-ba34-405f-a700-38e75103f44f.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjU4OTAwOTMsIm5iZiI6MTcyNTg4OTc5MywicGF0aCI6Ii81MjQ4OS8zNjAyMTgwMzctNDI5NDgyZjYtYmEzNC00MDVmLWE3MDAtMzhlNzUxMDNmNDRmLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA5MDklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwOTA5VDEzNDk1M1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTk4NTM2N2Y4NTY1MjI5MGZjMzhjMjNjMGE0YzgzNDEzNWUwM2U4YzNmM2VjYzM2YzgxZTMyYjFhN2IzNDNkMjImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.Sz2cuOrnE5uPCIFqNl_cFIXlLhGRtrtrY68Sj4Zc7cI)
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
v1.0.3
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
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.