Skip to content

Commit 509f594

Browse files
committed
updated docs
1 parent 0b21323 commit 509f594

File tree

2 files changed

+27
-6
lines changed

2 files changed

+27
-6
lines changed

docs/docs/getting-started/what's-new.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,27 @@ next: /docs/config-overview/
77

88
_NotifyBC_ uses [semantic versioning](https://semver.org/).
99

10+
## v5.0.0
11+
12+
See [Upgrade Guide](../upgrade/#v4-to-v5) for more information.
13+
14+
- Runs on _Nest_
15+
16+
::: tip Why v5?
17+
_NotifyBC_ has been built on Node.js [LoopBack](https://loopback.io/) since 2017. While _Loopback_ is an awesome framework, it is evident by 2022 _Loopback_ is no longer actively maintained
18+
19+
1. Features such as GraphQL have been in experimental state for years.
20+
2. Recent commits are mostly chores rather than enhancements.
21+
3. Core developers have ceased to contribute.
22+
23+
To pave the way for future growth, switching platform becomes necessary. Nest was chosen because
24+
25+
1. both _Nest_ and _Loopback_ are server-side Node.js frameworks
26+
2. _Nest_ has the closest feature set as _Loopback_. To a large extent _Nest_ is a superset of _Loopback_.
27+
3. _Nest_ incorporates more technologies
28+
29+
:::
30+
1031
## v4.1.0
1132

1233
- Issue [#50](https://github.com/bcgov/NotifyBC/issues/50): Email message throttle
@@ -84,15 +105,15 @@ See [v2 to v3 upgrade guide](../upgrade/#v2-to-v3) for more information.
84105
- misc web console adjustments
85106
- docs updates
86107

87-
::: tip Why v2?
88-
_NotifyBC_ has been built on Node.js [LoopBack](https://loopback.io/) framework since 2017. LoopBack v4, which was released in 2019, is backward incompatible. To keep software stack up-to-date, unless rewriting from scratch, it is necessary to port _NotifyBC_ to LoopBack v4. Great care has been taken to minimize upgrade effort.
89-
:::
90-
91108
## v2.0.0
92109

93-
See [Upgrade Guide](../upgrade/) for more information.
110+
See [Upgrade Guide](../upgrade/#v1-to-v2) for more information.
94111

95112
- Runs on LoopBack v4
96113
- All code is converted to TypeScript
97114
- Upgraded [OAS](https://swagger.io/specification/) from v2 to v3
98115
- Docs is converted from Jekyll to VuePress
116+
117+
::: tip Why v2?
118+
_NotifyBC_ has been built on Node.js [LoopBack](https://loopback.io/) framework since 2017. LoopBack v4, which was released in 2019, is backward incompatible. To keep software stack up-to-date, unless rewriting from scratch, it is necessary to port _NotifyBC_ to LoopBack v4. Great care has been taken to minimize upgrade effort.
119+
:::

docs/docs/meta/acknowledgments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ _NotifyBC_ is built on a myriad of open source software. At runtime it also depe
88
few services. Credit goes to their contributors. Notably
99

1010
- [Node.js](https://nodejs.org/)
11-
- [Loopback](https://loopback.io/)
11+
- [Nest](https://nestjs.com/)
1212
- [MongoDB](https://www.mongodb.com/)
1313
- [NodeMailer](https://nodemailer.com/)
1414
- [JMESPath](https://jmespath.org/)

0 commit comments

Comments
 (0)