Add component deprecation and archival process documentation #827
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds comprehensive documentation for the process of deprecating and archiving Cloud Posse components. The documentation includes a step-by-step guide covering: - Announcing deprecations via pull requests - Adding warning admonitions to READMEs - Updating README.yaml with deprecated field - Creating and pinning GitHub issues - Grace period for community migration - Repository archival process Also includes a blog post announcing the new documentation to the community. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Added explicit mention of cloudposse-terraform-components organization - Clarified that the process applies to modules, components, and other tooling - Updated both documentation and blog post for consistency 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
Should the GitHub Issue be created first? It’ll be referenced in the PR and any additional README updates made in the PR. I’m a bit confused about the ordering. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Details
This PR adds structured documentation for how Cloud Posse handles component deprecation and archival. The process includes:
deprecatedfield with notice text.github/settings.ymlto setarchived: trueThe documentation is added to
/community/contribute/our-github#deprecation-and-archival-processwhich seemed like the natural fit given the existing content about GitHub maintenance and archival.A blog post has been added to announce this new documentation to the community.
Test Plan
🤖 Generated with Claude Code