Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
f-w committed Dec 6, 2023
1 parent aebe121 commit e1fb167
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 10 deletions.
15 changes: 9 additions & 6 deletions docs/docs/getting-started/what's-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,26 @@ _NotifyBC_ uses [semantic versioning](https://semver.org/).

See [Upgrade Guide](../upgrade/#v4-to-v5) for more information.

- Runs on _Nest_
- Runs on _NestJS_

::: tip Why v5?
_NotifyBC_ was built on [LoopBack](https://loopback.io/) since the beginning. While _Loopback_ is an awesome framework, it is evident by 2022 _Loopback_ is no longer actively maintained
_NotifyBC_ was built on [LoopBack](https://loopback.io/) since the beginning. While _Loopback_ is an awesome framework at the time, it is evident by 2022 _Loopback_ is no longer actively maintained

1. features such as GraphQL have been in experimental state for years
2. recent commits are mostly chores rather than enhancements
3. core developers have ceased to contribute

To pave the way for future growth, switching platform becomes necessary. Nest was chosen because
To pave the way for future growth, switching platform becomes necessary. _NestJS_ was chosen because

1. both _Nest_ and _Loopback_ are server-side Node.js frameworks
2. _Nest_ has the closest feature set as _Loopback_. To a large extent _Nest_ is a superset of _Loopback_.
3. _Nest_ incorporates more technologies
1. both _NestJS_ and _Loopback_ are server-side Node.js frameworks
2. _NestJS_ has the closest feature set as _Loopback_. To a large extent _NestJS_ is a superset of _Loopback_
3. _NestJS_ incorporates more technologies

:::

- Bitnami MongoDB Helm chart is updated from version 10.7.1 to 14.3.2, with corresponding MongoDB from 4.4 to 7.0.4
- Bitnami Redis Helm chart is updated from version 14.7.2 to 18.4.0, with corresponding Redis from 6.2.4 to 7.2.3

## v4.1.0

- Issue [#50](https://github.com/bcgov/NotifyBC/issues/50): Email message throttle
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/meta/acknowledgments.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ _NotifyBC_ is built on a myriad of open source software. At runtime it also depe
few services. Credit goes to their contributors. Notably

- [Node.js](https://nodejs.org/)
- [Nest](https://nestjs.com/)
- [NestJS](https://nestjs.com/)
- [MongoDB](https://www.mongodb.com/)
- [NodeMailer](https://nodemailer.com/)
- [JMESPath](https://jmespath.org/)
Expand Down
8 changes: 5 additions & 3 deletions docs/docs/miscellaneous/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ v5 introduced following backward incompatible changes
1. Replica set is required for MongoDB. If you deployed NotifyBC using Helm, replica set is already enabled.
2. If you use default in-memory database, data in _server/database/data.json_ will not be migrated automatically. Manually migrate if necessary.
3. Update file _src/datasources/db.datasource.local.json_
3. Update file _src/datasources/db.datasource.local.[json|js|ts]_
1. rename _url_ property to _uri_
2. for other properties, instead of following [LoopBack MongoDB data source](https://loopback.io/doc/en/lb4/MongoDB-connector.html#creating-a-mongodb-data-source), follow [Mongoose connection options](https://mongoosejs.com/docs/connections.html#options). In particular, _host_, _port_ and _database_ properties are no longer supported. Use _uri_ instead.
Expand All @@ -294,7 +294,9 @@ v5 introduced following backward incompatible changes
}
```
4. API querying operators have changed. Replace following [Loopback operators](https://loopback.io/doc/en/lb4/Where-filter.html#operators) with corresponding [MongoDB operators](https://www.mongodb.com/docs/manual/reference/operator/query/) at client-side API call.
If you deployed NotifyBC using Helm, this is taken care of.
4. API querying operators have changed. Replace following [Loopback operators](https://loopback.io/doc/en/lb4/Where-filter.html#operators) with corresponding [MongoDB operators](https://www.mongodb.com/docs/manual/reference/operator/query/) at your client-side API call.
| Loopback operators | MongoDB operators |
| ----------------------- | ----------------------------------------------- |
Expand Down Expand Up @@ -327,7 +329,7 @@ v5 introduced following backward incompatible changes
7. When a subscription is created by anonymous user, the _data_ field is preserved. In earlier versions this field is deleted.
8. Dynamic tokens in subscription confirmation request message and duplicated subscription message are not replaced with subscription data, for example {subscription::...} tokens are left unchanged. Update the template of the two messages if dynamic tokens in them depends on subscription data.
9. [Inbound SMTP Server](../config-email/#inbound-smtp-server) no longer accepts command line arguments or environment variables as inputs. All inputs have to be defined in config files shown in the link.
10. If you deployed _NotifyBC_ using Helm, change MongoDB password format from
10. If you deployed _NotifyBC_ using Helm, change MongoDB password format in your local values yaml file from
```yaml
# in file helm/values.local.yaml
mongodb:
Expand Down

0 comments on commit e1fb167

Please sign in to comment.