upbound/universal-crossplane

Add API changes overview for new releases in UXP documentation

Closed this issue · 0 comments

What problem are you facing?

Today when a new minor release of UXP is released, we don't provide a summary with information on new and changed APIs for customers to understand the impact of upgrading.

How could UXP help solve your problem?

Add a step to the release process resulting in a changelog/upgrade entry added to the UXP documentation highlighting new APIs and changed APIs. This section is not intended to be an exhaustive overview of the changes but a curated collection of information upstream in Crossplane.

Customers should be able to look at the information for a new UXP release and understand its impact on the API.

This could also be written in an upgrade-guide style where we inform customers of what is new and what has changed.