Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ROADMAP): updates to public roadmap 🚀 #28302

Merged
merged 14 commits into from
Dec 8, 2023
Merged

feat(ROADMAP): updates to public roadmap 🚀 #28302

merged 14 commits into from
Dec 8, 2023

Conversation

awsmjs
Copy link
Contributor

@awsmjs awsmjs commented Dec 8, 2023

update to public roadmap


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@github-actions github-actions bot added p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Dec 8, 2023
@aws-cdk-automation aws-cdk-automation requested a review from a team December 8, 2023 13:37
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@awsmjs awsmjs changed the title Update ROADMAP.md fix(roadmap): Update ROADMAP.md Dec 8, 2023
@awsmjs awsmjs dismissed aws-cdk-automation’s stale review December 8, 2023 13:50

This is an update to a text page in repo

Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@awsmjs awsmjs dismissed aws-cdk-automation’s stale review December 8, 2023 14:04

this does not require testing, it is a text file update

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 8, 2023
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 8, 2023
@awsmjs awsmjs changed the title fix(roadmap): Update ROADMAP.md chore: ROADMAP doc updates Dec 8, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review December 8, 2023 14:08

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 8, 2023
Copy link
Contributor

@kaizencc kaizencc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a good start to me -- some stylistic changes that I think are necessary for the maintenance of this section going forward.

provides a high-level view of our work in progress across the [aws-cdk], [aws-cdk-rfcs], and [jsii]
repositories, and creates an opportunity for customers to engage in a conversation with AWS CDK engineers to
give us direct feedback.
The roadmap priorities for the AWS CDK (Cloud Development Kit) are informed by what we hear from customers and interactions on Github, CDK.dev Slack, Stack Overflow, and Twitter. This document outlines the high level direction we are working towards, and for each project there is a tracking issue where you can leave feedback. We update this doc on a quarterly basis to reflect any changing priorities.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we're missing a sentence introducing what the AWS CDK Roadmap is

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cdk.dev instead of CDK.dev?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also nit: we should split up paragraphs into individual lines so that they are easier to review and read in raw text.

ROADMAP.md Outdated
[aws-cdk]: https://github.com/aws/aws-cdk
[aws-cdk-rfcs]: https://github.com/aws/aws-cdk-rfcs
[jsii]: https://github.com/aws/jsii
Follow <a href="https://www.youtube.com/@CDK-Live">CDK Live!</a> and <a href="https://cdk.dev/">cdk.dev</a> to learn what's new in AWS CDK.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of these links work, but I find it kind of unusual to use html here. We can achieve the same ref directly in markdown like CDK Live!. View this comment in raw text to see the markdown syntax. We standardize on that everywhere else, I think we should use it here too.

ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated

4. **Provide the right level of detail**
<table>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for this -- there is a canonical way to do this in markdown syntax, which I prefer because it is easier to maintain and update the table in the future.

https://www.markdownguide.org/extended-syntax/#tables

ROADMAP.md Outdated

A: Please open an issue! Or engage by 👍 existing ones.
Q: Why did you build an open roadmap?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The QandA section doesn't render the way you're expecting, I think. You need a space between the lines for a space to show up in the markdown render.

ROADMAP.md Outdated
be released in the coming weeks.
* **In review** - It’s implementation is done and we are reviewing the code.
* **Done** - It’s available now, fully supported by AWS.
<img width="1174" alt="image" src="https://github.com/aws/aws-cdk/assets/142322013/ea006330-caa7-4c00-8eba-8e8fe379ef6b">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can also be done in markdown syntax, look at the raw markdown to see what i did: image

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 8, 2023
ROADMAP.md Outdated Show resolved Hide resolved
provides a high-level view of our work in progress across the [aws-cdk], [aws-cdk-rfcs], and [jsii]
repositories, and creates an opportunity for customers to engage in a conversation with AWS CDK engineers to
give us direct feedback.
The roadmap priorities for the AWS CDK (Cloud Development Kit) are informed by what we hear from customers and interactions on Github, CDK.dev Slack, Stack Overflow, and Twitter. This document outlines the high level direction we are working towards, and for each project there is a tracking issue where you can leave feedback. We update this doc on a quarterly basis to reflect any changing priorities.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Github, CDK.dev Slack, Stack Overflow, and Twitter

NIT: I think we can include CDK live in this too.

@vinayak-kukreja vinayak-kukreja added the pr/do-not-merge This PR should not be merged at this time. label Dec 8, 2023
Co-authored-by: Eric Z. Beard <ericzbeard@gmail.com>
@mergify mergify bot dismissed stale reviews from kaizencc and ericzbeard December 8, 2023 17:18

Pull request has been modified.

@kaizencc kaizencc removed the pr/do-not-merge This PR should not be merged at this time. label Dec 8, 2023
@kaizencc kaizencc changed the title chore: ROADMAP doc updates feat(ROADMAP): updates to public roadmap 🚀 Dec 8, 2023
@kaizencc kaizencc added pr-linter/exempt-readme The PR linter will not require README changes pr-linter/exempt-test The PR linter will not require test changes pr-linter/exempt-integ-test The PR linter will not require integ test changes labels Dec 8, 2023
kaizencc
kaizencc previously approved these changes Dec 8, 2023
ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated Show resolved Hide resolved
@mergify mergify bot dismissed kaizencc’s stale review December 8, 2023 17:43

Pull request has been modified.

ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated Show resolved Hide resolved
kaizencc
kaizencc previously approved these changes Dec 8, 2023
@mergify mergify bot dismissed kaizencc’s stale review December 8, 2023 17:53

Pull request has been modified.

kaizencc
kaizencc previously approved these changes Dec 8, 2023
@mergify mergify bot dismissed kaizencc’s stale review December 8, 2023 19:41

Pull request has been modified.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: e07f092
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Copy link
Contributor

mergify bot commented Dec 8, 2023

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit fe30921 into main Dec 8, 2023
14 checks passed
@mergify mergify bot deleted the awsmjs-patch-1 branch December 8, 2023 20:06

A: We create a tracking issue for each CDK feature, AWS Construct Library module, and jsii-supported programming language. Tracking issues provide a brief summary of the feature and a consolidated view of the work scoped for the release. They include links to design documentation, implementation details, and relevant issues. Tracking issues are living documents that start from a basic template and grow more robust over time as we experiment and learn. You can easily find tracking issues by filtering on the [management/tracking label](https://github.com/aws/aws-cdk/labels/management%2Ftracking).
**Q: Is everything on the roadmap?**
A: We will publish high-level direction that is within the scope of the CDK. Minor features and performance improvement tasks are not on the roadmap currently, but we are constantly trying to improve the roadmap so please leave your suggestions [here](https://github.com/aws/aws-sam-cli/issues/3267).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This appears to be a link to a closed issue on the aws-sam-cli repository, not the CDK. Is that the right place to leave comments and suggestions regarding AWS CDK?

@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK contribution/core This is a PR that came from AWS. p2 pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exempt-readme The PR linter will not require README changes pr-linter/exempt-test The PR linter will not require test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants