Releases: cloudposse/docs
Releases 路 cloudposse/docs
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-componentsGitHub 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
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.yamlof 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.mdis expected to be plain. If it is generated byREADME.yaml, then parse it like we do for top-level modules so we do not get the extra stuff that breaks Docusaurus.
Contributors
Nuru, korenyoni, and 2 other contributors
Assets 2
v0.87.0
v0.86.0
Add light/dark mode images @osterman (#603)
what
- Add light/dark mode images for "Terraform Open Source" modules
why
- For developers using darkmode
Fix some broken links @Nuru (#602)
what
- Fix broken links in pages under
content/docs/fundamentals/
why
- Some sections of the site have moved, but the links were not updated appropriately
Update info on Apple Silicon support, fix file layout comments @Nuru (#601)
what
- Update info on Apple Silicon support
- Update file layout and fix file layout comments
why
- Info was outdated and incorrect
- Layout was outdated, comments were in an unattached blob underneath the layout, and incomprehensible.
bugfix: image-zoom incorrect selector @Benbentwo (#600)
what
- Fixes selector to apply to all images in markdown divs, this applies to all sites
why
- Allows image zoom on all images
Contributors
osterman, Nuru, and Benbentwo
Assets 2
v0.85.0
feature: image zoom @Benbentwo (#599)
what
- Provides the ability to click on and view an enlarged photo
why
- Our docs contain quite a few images, it would be great to be able to view these with more clarity. this plugin should help with that.
references
Contributors
Benbentwo
Assets 2
v0.84.0
Update custom.css @Benbentwo (#598)
what
- Bugfix code blocks with tabs
why
- Code blocks look bad inside tabs
references
Introduction to Toolset Slides @milldr (#596)
what
- Adding Introduction to Toolset slides, with integration
why
- We want to embed slides in refarch, but the
Slides()function needs to be defined here with the website src
references
- JBI-134
- required by cloudposse/refarch-scaffold#369
Contributors
milldr and Benbentwo
Assets 2
v0.83.0
Fixed changelog issues @zdmytriv (#595)
what
- un-collapsed
<details>block for individual changelog pages - removed colons from
Commiters:andPull Requests: - capitalized H2 headers
- added link to github's
CHANGELOG.mdand to release
why
- Few visual improvements for changelog pages
note
Components under theme/MDXComponents were swizzled.
npm run swizzle @docusaurus/theme-classic MDXComponents -- --eject
and Details component has been updated to support opened <details> block for changelog
Added Changelog page for components @zdmytriv (#594)
what
Added Changelog page for components
why
- Added Changelog page for components
references
Merged Fundamentals @milldr (#593)
what
- Merged fundamentals from refarch
why
- Combine core fundamentals into a single category
references
- Related to internal PR cloudposse/refarch-scaffold#354
Added CHANGELOG per component @zdmytriv (#592)
what
- Rendering CHANGELOG.md at the very bottom of the component page
why
- Changelog will be added to the very bottom of the component page
references
Contributors
zdmytriv and milldr
Assets 2
v0.82.0
Fixed relative links to example and tests @zdmytriv (#589)
what
- Fixed relative links to example and tests
why
- Replacing relative links in READMEs with fully qualified URLs to corresponding GitHub files and folders
references
AWS components tree initially should not be collapsed in left sidebar @zdmytriv (#590)
what
- AWS components tree initially should not be collapsed in left sidebar
why
- UX improvements
references
Fixed folders rendering for eks and tgw @zdmytriv (#588)
what
- Fixed folders rendering for eks and tgw
why
- Fixed folders rendering for eks and tgw so these folders will get their own link
references
Update terraform testing docs and chatops @max-lobur (#578)
what
- Update Terraform testing docs in accordance to our recent work in https://github.com/cloudposse/github-actions-workflows-terraform-module/blob/main/.github/workflows/feature-branch.yml
why
- Preparing for the new shared workflows rollout
Added 'Sign Your Commits with SSH' page to best practices @zdmytriv (#587)
what
- Added 'Sign Your Commits with SSH' page to best practices
why
- Added 'Sign Your Commits with SSH' page to best practices
references
`.editorconfig` Typo @milldr (#586)
what
fixed intent typo
why
should be spelled "indent"
references
https://cloudposse.slack.com/archives/C01EY65H1PA/p1685638634845009
Contributors
dudymas, zdmytriv, and 2 other contributors
Assets 2
v0.81.3
v0.81.2
Update branding colors @osterman (#580)
what
- Use colors
- Update SVG logos for dark and block
- Use SVG where possible
why
- More aligned with our current branding on cloudposse.com
Added support for mermaid diagrams @zdmytriv (#579)
what
- Added mermaid theme and dependencies
- Upgraded docusaurus from
2.3.1->2.4.0
why
- Added mermaid diagrams support
- Upgraded docusaurus
```mermaid
sequenceDiagram
Alice ->> Bob: Hello Bob, how are you?
Bob-->>John: How about you John?
Bob--x Alice: I am good thanks!
Bob-x John: I am good thanks!
Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.
Bob-->Alice: Checking with John...
Alice->John: Yes... John, how are you?
it will get rendered into
references
Contributors
osterman and zdmytriv