Skip to content

RFC 249: Rewrite the V2 Experiments RFC to have a more working-backwards tone#377

Merged
njlynch merged 5 commits intomasterfrom
njlynch/v2-experiments-v2
Sep 1, 2021
Merged

RFC 249: Rewrite the V2 Experiments RFC to have a more working-backwards tone#377
njlynch merged 5 commits intomasterfrom
njlynch/v2-experiments-v2

Conversation

@njlynch
Copy link
Copy Markdown
Contributor

@njlynch njlynch commented Aug 26, 2021

While working on the release of the CDK v2 Experimental Modules, I found myself looking for a place to document and discuss some of the customer-facing decisions being made (e.g., package naming, versioning, Changelog organization). Unfortunately, the current state of RFC 249 does not lend itself well to this format (IMO); the RFC as-is is more implementation-focused and more heavily leans towards the why of many of the decisions. While absolutely useful context, it doesn't read as much as a working-backwards document as I'd like.

My mental model to solve this was to copy (and save!) this really useful decision-making document, and replace the main RFC body with a series of working-backwards artifacts that (hopefully?) capture the customer experience of working with the alpha/unstable modules.

We don't usually go back and update old RFCs, so I recognize maybe this isn't the correct approach. I am very open to feedback on whether (a) this is useful; and (b) this is the best way to go about documenting these decisions.

Apologies for the ugly diff. I'd recommend opening up the rendered version of the new RFC to review, rather than viewing the diff directly.

[Rendered Version]


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

@njlynch njlynch force-pushed the njlynch/v2-experiments-v2 branch from 03d9294 to bb25608 Compare August 26, 2021 12:23
@njlynch njlynch self-assigned this Aug 26, 2021
Copy link
Copy Markdown
Contributor

@nija-at nija-at left a comment

Choose a reason for hiding this comment

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

Much better than the previous RFC.

I don't have any deep questions here but a few things worth cleaning up before merging.

Co-authored-by: Niranjan Jayakar <nija@amazon.com>
@mergify mergify bot dismissed nija-at’s stale review August 26, 2021 16:05

Pull request has been modified.

@njlynch njlynch requested review from nija-at and rix0rrr August 26, 2021 16:07
nija-at
nija-at previously approved these changes Aug 26, 2021
Copy link
Copy Markdown
Contributor

@nija-at nija-at left a comment

Choose a reason for hiding this comment

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

Please also see
#377 (comment) and #377 (comment)

Otherwise LGTM.

I suggest keeping this RFC around for a couple of more days to see if others have anything to say.

@nija-at
Copy link
Copy Markdown
Contributor

nija-at commented Aug 26, 2021

We don't usually go back and update old RFCs, so I recognize maybe this isn't the correct approach.

I believe this is the correct thing to do if our choices have changed during implementation of the original RFC.

OTOH, if these changes are part of a new project, then a new RFC is better.

Copy link
Copy Markdown
Contributor

@skinny85 skinny85 left a comment

Choose a reason for hiding this comment

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

Looks great. Some minor comments, but no major disagreements from me.

rix0rrr
rix0rrr previously approved these changes Aug 27, 2021
@mergify mergify bot dismissed stale reviews from nija-at and rix0rrr August 27, 2021 09:43

Pull request has been modified.

Copy link
Copy Markdown
Contributor

@skinny85 skinny85 left a comment

Choose a reason for hiding this comment

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

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants