docs: upgrading notes

This commit is contained in:
Taylor Schley
2022-02-21 17:45:41 -06:00
parent 092ce194ec
commit ea5aceedfd
3 changed files with 20 additions and 0 deletions
+6
View File
@@ -26,6 +26,7 @@
* [Foreword](#foreword)
* [Install](#install)
* [Upgrading](#upgrading)
* [Usage and Examples](#usage-and-examples)
* [Instance Options](#instance-options)
* [Job Options](#job-options)
@@ -77,6 +78,11 @@ yarn add bree
```
## Upgrading
To see details about upgrading from the last major version, check out this [doc](./UPGRADING.md).
## Usage and Examples
The example below assumes that you have a directory `jobs` in the root of the directory from which you run this example. For example, if the example below is at `/path/to/script.js`, then `/path/to/jobs/` must also exist as a directory. If you wish to disable this feature, then pass `root: false` as an option.
+10
View File
@@ -0,0 +1,10 @@
# Upgrading
## Upgrading from 7.x to 8.0
* Some fields have been converted from Objects to Maps:
* `closeWorkerAfterMs`
* `workers`
* `timeouts`
* `intervals`
+4
View File
@@ -10,6 +10,10 @@ docute.init({
{
title: 'The best job scheduler for Node.js and JavaScript',
path: '/'
},
{
title: 'Upgrading',
path: '/UPGRADING'
}
]
},