Skip to content

Commit ef00f92

Browse files
authored
docs: add instructions for creating versioned documentation (#961)
* docs: add instructions for creating versioned documentation * docs: update version number for versioned documentation creation
1 parent e670407 commit ef00f92

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

dev/release.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,5 +229,11 @@ Set up a GitHub Actions workflow that:
229229
git push origin v1.0.0
230230
```
231231
- **Bump the version** in `main` to the next development version (e.g., `1.1.0.dev0`).
232+
- **Create versioned documentation**:
233+
```bash
234+
cd website
235+
npm run version 1.0.0
236+
```
237+
This creates a snapshot of the current docs under `versioned_docs/version-1.0.0/` and adds the version to `versions.json`. Update `docusaurus.config.ts` to configure the new version label and path if needed.
232238
- **Announce the release** on `dev@mahout.apache.org`.
233239
- **Update website documentation** with the new release notes.

0 commit comments

Comments
 (0)