docs icon indicating copy to clipboard operation
docs copied to clipboard

Promote CompositionRevisions to GA (v1)

Open negz opened this issue 1 year ago • 5 comments

What's Missing?

https://docs.crossplane.io/knowledge-base/guides/composition-revisions/

The content on Composition Revisions is currently a guide, separate from content that is versioned alongside Crossplane. I'd like to update this content to reflect that Composition Revisions is GA (i.e. v1) in Crossplane v1.12 but I am not sure how to go about that.

I think we have this as a 'guide' because we wanted it to be separate from the 'main' documentation flow while it was an alpha/beta feature that folks could opt into/out of. Now that it's GA you cannot opt out of it. It's always on (in 1.12).

Ideally for folks on v1.12 I'd like to merge the content of the guide into the 'main' docs - presumably into the getting started guides and/or the Composite Resources section under Concepts. It seems like the above rationale still holds for anyone on v1.11 or earlier though, and the guides section of the content is not associated with a particular Crossplane version. Perhaps we should add a marker to the guide to let folks know that the feature is GA in v1.12 per https://github.com/crossplane/docs/issues/417?

negz avatar Apr 25 '23 22:04 negz

Note that nothing changed WRT how revisions work with the promotion, so the content is still accurate.

negz avatar Apr 25 '23 22:04 negz

we dropped old versions with https://github.com/crossplane/crossplane/pull/4098 and since v1.13.1 we upgrading the storage version during init process

haarchri avatar Aug 02 '23 16:08 haarchri

Fixed with #710

plumbis avatar Feb 16 '24 17:02 plumbis

@plumbis I was hoping to get the revisions content out of the KB and into the main docs. I noticed there's a bunch of vale issues with the current content too.

Should we reopen this to track that? Or raise a new issue?

negz avatar Feb 16 '24 20:02 negz

What's in the KB today is from the original content before we introduced vale. Vale fixes have gone in as pages are rewritten and this one hasn't been tackled yet.

I missed that the goal of this was to move it out of the KB, I should read more closely. Reopening.

plumbis avatar Feb 16 '24 20:02 plumbis