[docs-infra] Update Release Instructions and Search Index v7 by dav-is · Pull Request #48109 · mui/material-ui (original) (raw)

Choose a reason for hiding this comment

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

I'm afraid that having special deployment for one branch is going to confuse someone some day soon. Wouldn't you really consider just creating a v8.x branch that we push to v8 on docs? I understand the cost for us is to maintain 1 more branch which is going to be very close (if not the same for a while). I wouldn't also automatically assume we will never want to add changes the docs for v8 specifically that we don't want on v7.

The rules would be very straightforward:

• material-ui:vx.y = source of truth, bring the branch into desired state that you want to be on the docs
• for each branch: deploy = push material-ui:vx.y to material-ui-docs:vx

That way we never have to explain the little exception around v7/v8 to new people, and we reduce the chance of someone messing up that forgot to read this specific README. This will be especially helpful 1 year from now when we're two majors further and everybody has forgotten about this little caveat.