Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
f-w committed Jul 25, 2021
1 parent de50e4f commit 250f166
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 6 deletions.
1 change: 0 additions & 1 deletion .github/workflows/buildTestPublishContainerDeploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ on:
push:
branches:
- main
- issue50
release:
types:
- published
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/config/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Check out [Nodemailer](https://nodemailer.com/smtp/) for other config options th

## Throttle

SMTP servers may impose request rate limit. _NotifyBC_ can throttle request under the rate limit. To enable throttle and set rate limit, create following config in file _/src/config.local.js_
_NotifyBC_ can throttle email requests if SMTP server imposes rate limit. To enable throttle and set rate limit, create following config in file _/src/config.local.js_

```js
module.exports = {
Expand Down
6 changes: 6 additions & 0 deletions docs/docs/getting-started/what's-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ permalink: /docs/what's-new/

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

## v4.1.0

- Issue [#50](https://github.com/bcgov/NotifyBC/issues/50): Email message throttle
- applied sms throttle to all sms messages rather than just broadcast push notification.
- docs updates

## v4.0.0

See [v3 to v4 upgrade guide](../upgrade/#v3-to-v4) for more information.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/miscellaneous/developer-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ You can now browse to the local docs site [http://localhost:8080/NotifyBC](http:
Before adding a release,

1. update _version_ in _package.json_
2. update _appVersion_ in _helm/Chart.yaml_ (major/minor only)
2. update _version_ _appVersion_ in _helm/Chart.yaml_ (major/minor only)
3. update [What's new](../getting-started/what's-new.md) (major/minor only)
4 changes: 2 additions & 2 deletions helm/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 1.0.0
version: 1.1.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: 4.0
appVersion: 4.1

dependencies:
- name: mongodb
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "notify-bc",
"version": "4.0.0",
"version": "4.1.0",
"dbSchemaVersion": "0.8.0",
"description": "A versatile notification API server",
"keywords": [
Expand Down

0 comments on commit 250f166

Please sign in to comment.