chore: add a notice for AWS CDK v1 going into maintenance mode soon #9
Conversation
madeline-k
changed the title
|
The version is valid, but it's not passing the test 🤷♂️. You can try and replace it with |
| { | ||
| "title": "AWS CDK v1 entering maintenance mode soon", | ||
| "issueNumber": 19836, | ||
| "overview": "AWS CDK v1 is entering maintenance mode on June 1, 2022. Migrate to AWS CDK v2 to continue to get the latest features and fixes!", |
There was a problem hiding this comment.
Just a nit, but maybe we should provide a link to the migration documentation at the end of this message.
There was a problem hiding this comment.
I don't think this is a nit. The migration documentation is essential for people to be able to take action from this notice and we want it to be easy to find. I included it in the linked github issue. At the bottom of each notice, the CLI prints out "More information at: https://github.com/aws/aws-cdk/issues/<#>". Because of this, I chose to not include a link to the migration guide directly here, to not overwhelm the CLI output with a bunch of links. Do you think it will be easy enough to find that way? Or should we include it here as well?
There was a problem hiding this comment.
Maybe we should add any unique information from the README into the "Migrate to v2" topic in the Developer Guide, and link directly to that topic from the CLI?
There was a problem hiding this comment.
Which README?
We have two options here (let me know if there are more):
- (Current implementation) The CLI notice will have a single link to AWS CDK v1 will enter Maintenance Mode after June 1, 2022 aws/aws-cdk#19836. This issue has a link to the "Migrating to AWS CDK v2" topic in the Developer Guide.
- The CLI notice will link to both AWS CDK v1 will enter Maintenance Mode after June 1, 2022 aws/aws-cdk#19836 and https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html
Option 1 is a cleaner CLI output, but requires 2 clicks to get to the "Migrating to AWS CDK v2" page.
I'm still leaning toward option 1 as implemented. But I it's important we make this documentation easy to find for people. So I'm open to option 2 as well.
There was a problem hiding this comment.
If there's a clear path to the migration documentation, and I think there is from that issue, I would be inclined to agree with the current implementation. I didn't know that the "more information at..." line was included so I think this is good.
There was a problem hiding this comment.
I agree, the current implementation is the way to go.
I tried to keep the notice short, and added more detail in the linked issue: aws/aws-cdk#19836
Fixes https://github.com/cdklabs/cdk-ops/issues/1934