Skip to content

Commit

Permalink
reduce instructions to what is useful for the 4.2 branch
Browse files Browse the repository at this point in the history
  • Loading branch information
jodygarnett committed May 24, 2024
1 parent 6db9d71 commit fde7191
Showing 1 changed file with 3 additions and 23 deletions.
26 changes: 3 additions & 23 deletions docs/manual/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,40 +113,20 @@ We use ``mike`` for publishing (from the `gh-pages` branch). Docs are published

If you wish to preview using your own `gh-pages` branch:

1. To deploy 4.4 docs as latest from the `main` branch to website `gh-pages` branch:

```bash
mike deploy --title "4.4 Latest" --alias-type=copy --update-aliases 4.4 latest
```

2. To deploy documentation for a new release:
1. To deploy documentation for a new stable release:

```bash
mike deploy --push --alias-type=copy 4.2 stable
```

3. When starting a new branch you can make it the default:

```bash
mike set-default --push 4.6
```

Hint: When starting a new branch update `overview/changelog/history/index.md` headings for latest, maintenance, stable (for prior branches also).

4. To publish documentation for a maintenance release:

```bash
mike deploy --push --alias-type=copy 3.12 maintenance
```

5. To show published versions:
2. To show published versions:

```bash
mike list
```

6. To preview things locally (uses your local ``gh-pages`` branch):
3. To preview things locally (uses your local ``gh-pages`` branch):

```bash
mike serve
Expand Down

0 comments on commit fde7191

Please sign in to comment.