A new stable version of the Besu documentation is released when a new version of the Besu software is released.
To release the documentation, first run the following command to create a new doc version:
| Code Block |
|---|
| language | bash |
|---|
| title | Create a new doc version |
|---|
|
npm run docusaurus docs:version <VERSION-NUMBER> |
In docusaurus.config.js , under presets > classic > docs > version , add the new version and update the label to stable (<VERSION-NUMBER>) and the path to stable . Update the previous version to remove the stable label and path, and add an unmaintained banner to the previous version. For example, when updating from version 23.4.1 to 23.4.2 , update the following section in docusaurus.config.js from the following:
| Code Block |
|---|
| language | js |
|---|
| title | docusaurus.config.js (before) |
|---|
|
versions: {
current: {
label: "development",
path: "development",
banner: "unreleased",
},
"23.4.1": {
label: "stable (23.4.1)",
path: "stable",
banner: "none",
},
"23.4.0": {
label: "23.4.0",
path: "23.4.0",
banner: "unmaintained",
},
}, |
To the following:
| Code Block |
|---|
| language | js |
|---|
| title | docusaurus.config.js (after) |
|---|
|
versions: {
current: {
label: "development",
path: "development",
banner: "unreleased",
},
"23.4.2": {
label: "stable (23.4.2)",
path: "stable",
banner: "none",
},
"23.4.1": {
label: "23.4.1",
path: "23.4.1",
banner: "unmaintained",
},
"23.4.0": {
label: "23.4.0",
path: "23.4.0",
banner: "unmaintained",
},
}, |