Create breaking change release messaging for updated Card and Stepper components

cds-snc / design-gc-conception

MIT License

4 stars 0 forks source link

Create breaking change release messaging for updated Card and Stepper components #1021

Closed adorayi closed 1 month ago

adorayi commented 2 months ago

As the card component is being updated with breaking changes, a release message to inform users will be required

✅ Definition of Done / Outcomes

[x] Release messaging written and reviewed by engagement and devs
[x] Message is reviewed by technical team
[x] Message has been translated
[x] Message has been sent out

📜 Acceptance criteria:

[x] Message is drafted covering what is changing, why, and how it will affect users
[x] Message is available in EN and FR
[x] Messages have been sent

More info: We're releasing updates to the Card component (see Changes from V1 to V2) which includes some breaking changes. We need to remind our users to use a pinned version if they do not have the capacity to implement the changes immediately.

daine commented 2 months ago

Here is the document for the messaging on updates to the Card and Stepper components (breaking changes): https://docs.google.com/document/d/1Ve0hc3Awuzse_k5FVYTuopCS1p06i80hYNdW_ioNEaU/edit#heading=h.t5krr71smdbz

And here is the document for the messaging of the new react ssr package: https://docs.google.com/document/d/19DVkjZrTg-qoBEgaw-u1woi_mlPQZK1TrCWsfj4pWNU/edit#heading=h.s3vz6ryynczy

daine commented 2 months ago

Work on this is on pause pending decision from @abdul regarding the changes on the Card and Stepper slots (giving users option to add HTML formatting but also potentially opening up the component to be misused)

SmartMouthWords commented 2 months ago

Reviewed the card and stepper message and the canary release and proposed changes for plain language and to increase clarity. I've added the document to the Writer safelist and done a review using the tool. You can always re-rerun it if you make any more changes. Note: you need to accept suggestions/track changes for Writer to work properly.

daine commented 1 month ago

Meeting with Amy this week for a final review (as well brainstorming on creating a template for them) before sending these documents off for translation

daine commented 1 month ago

Amy approved the documents last Friday, I sent them to translation through the slack channel today.

EliseKa commented 1 month ago

Translation completed, documents shared in Slack channel and here: -Card and Stepper breaking change messaging -React Canary release messaging

daine commented 1 month ago

The messages were sent through the mailing list on August 12th, this ticket can now be closed.