Skip to content

Commit

Permalink
[core] Add instructions to deploying docs guide (#41582)
Browse files Browse the repository at this point in the history
  • Loading branch information
DiegoAndai authored Mar 21, 2024
1 parent 22fd95b commit 6983bde
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,19 @@ To do so, follow these steps:
git remote add material-ui-docs https://github.com/mui/material-ui-docs.git
```

2. Switch to the `latest` branch from `material-ui-docs` remote:
2. Fetch the latest changes from the `material-ui-docs` remote:

```bash
git fetch material-ui-docs latest
```

3. Switch to the `latest` branch from `material-ui-docs` remote:

```bash
git switch --detach material-ui-docs/latest
```

3. Cherry-pick the commit(s) that you want to include in the new deployment:
4. Cherry-pick the commit(s) that you want to include in the new deployment:

```bash
git cherry-pick <commit>
Expand All @@ -81,13 +87,17 @@ To do so, follow these steps:

In case of conflicts you will need to resolve them and commit the changes manually.

4. Push the changes to the `material-ui-docs` remote:
If this command fails with the message 'bad revision', it means that the commit doesn't exist on your local repository.
The commit might have been created on a remote branch, probably when merging into `master` or `next`.
In this case, you'll have to fetch the latest changes of the corresponding remote branch and then try again.

5. Push the changes to the `material-ui-docs` remote:

```bash
git push material-ui-docs HEAD:latest
```

5. Switch from detached `HEAD` back to your last checked out branch:
6. Switch from detached `HEAD` back to your last checked out branch:

```bash
git checkout -
Expand Down

0 comments on commit 6983bde

Please sign in to comment.