origami icon indicating copy to clipboard operation
origami copied to clipboard

Content request: Component lifecycle

Open notlee opened this issue 4 years ago • 3 comments

We lost component lifecycle documentation with the removal of the specification.

https://origami.ft.com/spec/v1/components/#component-lifecycle

It should be reviewed and moved to the docs section, and include missing information such as how to release a component, backport a feature, and any other related topics.

notlee avatar Sep 06 '21 14:09 notlee

yes, let's have a meeting about this and see what we think this should be.

let's revisit the idea of replacing our supportStatus concept with biz-ops project status

let's also document our use of semver, and in contrast to the old doc let's also explain why a major bump to an existing dependency requires a major bump to the dependent.

chee avatar Sep 15 '21 10:09 chee

As per Slack:

I’ve been looking at documenting the component lifecycle and realise that it’s not going to be as simple as copying stuff over and tweaking. It relates to other pages of the site like "docs/components/versioning" so we’re going to need to put some more thought into content structure. And particularly because right now the target audience is a bit mixed up between “user: we use semver, this is the range we recommend you use to request components” and “user: here are our promises to you, we won’t go deleting features in a minor/patch, you will be notified in this way of major changes” and “contributor: this is how to actually technically deprecate a feature”.

This is a brain dump for later. It’s too late on a Friday for me to think hard right now :sweat_smile:

notlee avatar Oct 22 '21 16:10 notlee

We still want to do this. It's not currently an OKR for this quarter. We think it's a bigger piece of work which involves a broader documentation review/overhaul

notlee avatar Jan 10 '22 12:01 notlee