[docs] Update release instructions #36113
Conversation
Netlify deploy previewNo updates. Bundle size report |
mj12albert
force-pushed
the
docs/release-instructions
branch
from
132bc0b to
dbb9a6b
Compare
mj12albert
force-pushed
the
docs/release-instructions
branch
from
dbb9a6b to
1dbf429
Compare
| @@ -29,17 +42,8 @@ The following steps must be proposed as a pull request. | |||
|
|
|||
| ### Documentation | |||
|
|
|||
| Push the next branch on the release branch to deploy the documentation with the latest changes. It lives at https://material-ui.netlify.app/. Force push if necessary. | |||
There was a problem hiding this comment.
If I understand this correctly, only yarn docs:deploy is needed to do this step.
The way that this was written originally made me think "Push the next branch..." and and yarn docs:deploy were two separate actions
| ### Prerequisites | ||
|
|
||
| 1. You must be a member of the `@mui` org in npm to publish the release | ||
| 1. Set up your npm authToken by logging into npm (`npm login`) . This will save a token to `~/.npmrc` as a line that looks |
There was a problem hiding this comment.
Could you update the numbering? It looks better when reading plain text (not rendered markdown). I wouldn't mind having correct indexes in other lists in this file as well.
| yarn docs:deploy | ||
| ``` | ||
| `yarn docs:deploy` to deploy the documentation (it lives at https://material-ui.netlify.app/) with the latest changes. | ||
| Force push if necessary. |
There was a problem hiding this comment.
We could almost add -f in
Line 12 in 16a8adb
So we never need to worry about this. It's totally normal to have to push force in the current workflow.
| Force push if necessary. |
There was a problem hiding this comment.
I also wondered if this was more convenient – is it common to have to force push to get this part to work? 🧐 @mui/core
There was a problem hiding this comment.
It depends on either website changes were cherry-picked to be deployed outside of the MUI Core docs release cycle. Maybe 5% of the time?
There was a problem hiding this comment.
I didn't needed to force push for a long time, but having it by default would indeed improve the experience, especially for new joiners 👍
There was a problem hiding this comment.
I just had to force push to deploy!
Will open a new issue for further edit suggestions to this doc (e.g. combine some of the yarn steps with &&)
There was a problem hiding this comment.
Yeah, we had to cherry-pick to do a hot deploy to fix https://mui-org.slack.com/archives/C041SDSF32L/p1676634426113669.
Proposing some updates to the instructions after doing this process for the first time ~