From 0acc828cc7b18dedd722b02377485cd0e22bc80e Mon Sep 17 00:00:00 2001 From: Pawan Jain Date: Sun, 1 Jan 2023 23:16:03 +0530 Subject: [PATCH 1/5] feat: add subscriber faq and angular version info --- docs/docs/notification-center/angular-component.md | 12 ++++++++++++ docs/docs/platform/subscribers.md | 14 +++++++++++++- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/docs/notification-center/angular-component.md b/docs/docs/notification-center/angular-component.md index e8b06acef8d..ec5669a0578 100644 --- a/docs/docs/notification-center/angular-component.md +++ b/docs/docs/notification-center/angular-component.md @@ -12,6 +12,12 @@ The `@novu/notification-center-angular` package provides an Angular component wr npm install @novu/notification-center-angular ``` +:::note + +Only >0.15.0 angular version is supported + +::: + ## Example usage Module: @@ -59,3 +65,9 @@ Component HTML template: ## Props The `notification-center-component` accepts the same set of props as the [Web Component](./web-component#properties). + +:::info + +May need to add "allowSyntheticDefaultImports": true in tsconfig.json and @types/react as dev dependency to work angular component properly. + +::: diff --git a/docs/docs/platform/subscribers.md b/docs/docs/platform/subscribers.md index a8ea61aaff8..738d4acd378 100644 --- a/docs/docs/platform/subscribers.md +++ b/docs/docs/platform/subscribers.md @@ -8,7 +8,7 @@ Novu manages your users in a specific subscribers data model, that allows the No A novu subscriber contains the following data points: -- **User data** - Data stored in the subscriber object that you can easily access in your notification templates. This contains basic info such as name, gender, profile picture, etc... +- **User data** - Data stored in the subscriber object that you can easily access in your notification templates. This contains basic info such as first name, last name, avatar, etc... - **Contact information** - Things like e-mail, phone number, push tokens, etc... They will be used when a multi-channel template will be configured. Managing all communication credentials will reduce the amount of data you need to pass when triggering a notification. ## Creating a subscriber @@ -83,3 +83,15 @@ await novu.subscribers.remove(user.id); ## Subscriber Preferences Novu manages a data model to help your users configure their preferences in an easy way. You can learn more about this in the [Subscriber Preferences](/platform/preferences) section. + +## Frequently Asked Questions + +
+ How to store custom properties in subscriber +

Subscribers have fixed schema. Storing custom properties is not supported but here is a work around, you can store that property in your database and send those values in payload option of trigger using variables. Read more about variables here .

+
+ +
+ How to get subscriber properties before step execution in workflow +

Workflow has access to all existing properties of subscriber as well as payload variables. So there is no any extra step needed

+
From 3049b65b8d2fe3b467a707e81232613dfbd69b08 Mon Sep 17 00:00:00 2001 From: Pawan Jain Date: Mon, 2 Jan 2023 08:27:44 +0530 Subject: [PATCH 2/5] feat: add few more docs --- docs/docs/channels/push/fcm.md | 6 +++++ docs/docs/community/faq.md | 24 +++++++++++++++++-- .../notification-center/react-components.md | 21 ++++++++++++++++ docs/docs/overview/docker-deploy.md | 2 +- 4 files changed, 50 insertions(+), 3 deletions(-) diff --git a/docs/docs/channels/push/fcm.md b/docs/docs/channels/push/fcm.md index 3dc29ced394..549141fe7a2 100644 --- a/docs/docs/channels/push/fcm.md +++ b/docs/docs/channels/push/fcm.md @@ -43,3 +43,9 @@ await novu.subscribers.setCredentials('subscriberId', PushProviderIdEnum.FCM, { deviceTokens: ['token1', 'token2'], }); ``` + +:::info + +Novu uses FCM version V1 + +::: diff --git a/docs/docs/community/faq.md b/docs/docs/community/faq.md index 3cb798bc380..f2380dc966c 100644 --- a/docs/docs/community/faq.md +++ b/docs/docs/community/faq.md @@ -2,7 +2,8 @@ Here we will outline some of the most common questions we get asked about the project. Missing a question? Feel free to open an [issue](https://github.com/novuhq/novu/issues) or PR to add it to the list. -## What are the dependencies required to run Novu? +
+ What are the dependencies required to run Novu. Novu consists of multiple services written in Node.js and Typescript. The following are the dependencies required to run the project fully: @@ -11,7 +12,10 @@ Novu consists of multiple services written in Node.js and Typescript. The follow - Redis - File storage (S3/GCP/Azure) - Optional -## How do I customize messages on Novu? +
+ +
+How do I customize messages on Novu? In Novu, [handlebar variables](https://handlebarsjs.com/guide/) (variables enclosed within double curly brackets) are used to customize messages. Using this, one can take advantage of the following tools: @@ -35,3 +39,19 @@ In Novu, [handlebar variables](https://handlebarsjs.com/guide/) (variables enclo ``` For an in-depth explanation with examples, check out [Templates](https://docs.novu.co/platform/templates#messages). + +
+ +
+Is creating and switching to new organisation deactivates other organisations + +No, switching organisation will only switch organisation in UI, from API side all organisations are still active. Each organisation has different api keys, subscibers and notification templates. Notification template of one organisation can not be used with other organisation's subscriber. + +
+ +
+Is is possible to have multiple active providers per channel + +Multiple active providers are only supported in [push](../channels/push) and [chat](../channels/chat) channels. + +
diff --git a/docs/docs/notification-center/react-components.md b/docs/docs/notification-center/react-components.md index 8045fc5df4b..dd24b1efb19 100644 --- a/docs/docs/notification-center/react-components.md +++ b/docs/docs/notification-center/react-components.md @@ -635,3 +635,24 @@ By default, Novu will show the subscriber preferences cog icon on the notificati If you want to hide it, you can use the prop `showUserPreferences` on the `PopoverNotificationCenter` component. ![Notification Center with a cog](/img/notification-list-cog.png) + +## FAQ + +
+ Notification center is not loading properly + +Possible causes of not loading notifcation center properly + +- Invalid subscriberId +- Invalid applicationIdentifier +- Invalid backendUrl (in case of self hosted) +- Invalid socketUrl (in case of self hosted) + +
+ +
+ There is render error due to Notification center + +Notification center should be wrapped in NovuProvider + +
diff --git a/docs/docs/overview/docker-deploy.md b/docs/docs/overview/docker-deploy.md index 5452717fc90..fc3a1168f01 100644 --- a/docs/docs/overview/docker-deploy.md +++ b/docs/docs/overview/docker-deploy.md @@ -46,7 +46,7 @@ Update the `.env` file with your own secrets. In particular, these are required: To keep the setup simple, we made some choices that may not be optimal for production: - the database is in the same machine as the servers -- the storage uses the filesystem backend instead of S3 +- the storage uses localstack instead of S3 We strongly recommend that you decouple your database before deploying. From ecaf40fef01ff8b60c8c1955db4f830f6e65ebdc Mon Sep 17 00:00:00 2001 From: Pawan Jain Date: Mon, 2 Jan 2023 08:35:31 +0530 Subject: [PATCH 3/5] fix: spelling errors --- docs/docs/community/faq.md | 4 ++-- docs/docs/notification-center/react-components.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/community/faq.md b/docs/docs/community/faq.md index f2380dc966c..4ea7136dc2b 100644 --- a/docs/docs/community/faq.md +++ b/docs/docs/community/faq.md @@ -43,9 +43,9 @@ For an in-depth explanation with examples, check out [Templates](https://docs.no
-Is creating and switching to new organisation deactivates other organisations +Is creating and switching to new organization deactivates other organizations -No, switching organisation will only switch organisation in UI, from API side all organisations are still active. Each organisation has different api keys, subscibers and notification templates. Notification template of one organisation can not be used with other organisation's subscriber. +No, switching organization will only switch organization in UI, from API side all organizations are still active. Each organization has different api keys, subscribers and notification templates. Notification template of one organization can not be used with other organization's subscriber.
diff --git a/docs/docs/notification-center/react-components.md b/docs/docs/notification-center/react-components.md index dd24b1efb19..bedd5f3d569 100644 --- a/docs/docs/notification-center/react-components.md +++ b/docs/docs/notification-center/react-components.md @@ -641,7 +641,7 @@ If you want to hide it, you can use the prop `showUserPreferences` on the `Popov
Notification center is not loading properly -Possible causes of not loading notifcation center properly +Possible causes of not loading notification center properly - Invalid subscriberId - Invalid applicationIdentifier From 86d89c2eccebfdf8319f74e87cc9966ddbb55478 Mon Sep 17 00:00:00 2001 From: Pawan Jain Date: Mon, 2 Jan 2023 17:19:48 +0530 Subject: [PATCH 4/5] fix: add vue 3 support info --- docs/docs/notification-center/angular-component.md | 4 +--- docs/docs/notification-center/vue-component.md | 4 ++++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/docs/notification-center/angular-component.md b/docs/docs/notification-center/angular-component.md index ec5669a0578..95ed734080a 100644 --- a/docs/docs/notification-center/angular-component.md +++ b/docs/docs/notification-center/angular-component.md @@ -13,9 +13,7 @@ npm install @novu/notification-center-angular ``` :::note - -Only >0.15.0 angular version is supported - +Novu supports Angular version >0.15.0. ::: ## Example usage diff --git a/docs/docs/notification-center/vue-component.md b/docs/docs/notification-center/vue-component.md index 03ca03216e2..6d40caae73f 100644 --- a/docs/docs/notification-center/vue-component.md +++ b/docs/docs/notification-center/vue-component.md @@ -12,6 +12,10 @@ The `@novu/notification-center-vue` package provides a Vue component wrapper ove npm install @novu/notification-center-vue ``` +:::note +Novu supports only Vue 3. +::: + ## The plugin The Notification Center Vue plugin can be used to register the `NotificationCenterComponent` as a global component. This is the recommended way to use the component. From 0c2aac894d07db54433340e8def2dddd4e2f0ca1 Mon Sep 17 00:00:00 2001 From: Pawan Jain Date: Tue, 3 Jan 2023 21:42:46 +0530 Subject: [PATCH 5/5] fix: add gali's suggestions --- docs/docs/community/faq.md | 2 +- docs/docs/notification-center/angular-component.md | 4 +--- docs/docs/notification-center/react-components.md | 2 +- docs/docs/platform/subscribers.md | 2 +- 4 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/docs/community/faq.md b/docs/docs/community/faq.md index 4ea7136dc2b..ec89ae7a8f0 100644 --- a/docs/docs/community/faq.md +++ b/docs/docs/community/faq.md @@ -43,7 +43,7 @@ For an in-depth explanation with examples, check out [Templates](https://docs.no
-Is creating and switching to new organization deactivates other organizations +Is creating and switching to a new organization deactivates the other organizations? No, switching organization will only switch organization in UI, from API side all organizations are still active. Each organization has different api keys, subscribers and notification templates. Notification template of one organization can not be used with other organization's subscriber. diff --git a/docs/docs/notification-center/angular-component.md b/docs/docs/notification-center/angular-component.md index 95ed734080a..9f1cae66e8e 100644 --- a/docs/docs/notification-center/angular-component.md +++ b/docs/docs/notification-center/angular-component.md @@ -65,7 +65,5 @@ Component HTML template: The `notification-center-component` accepts the same set of props as the [Web Component](./web-component#properties). :::info - -May need to add "allowSyntheticDefaultImports": true in tsconfig.json and @types/react as dev dependency to work angular component properly. - +May need to add "allowSyntheticDefaultImports": true in tsconfig.json and @types/react as dev dependency for the angular component to work properly ::: diff --git a/docs/docs/notification-center/react-components.md b/docs/docs/notification-center/react-components.md index bedd5f3d569..2aaac51a59a 100644 --- a/docs/docs/notification-center/react-components.md +++ b/docs/docs/notification-center/react-components.md @@ -641,7 +641,7 @@ If you want to hide it, you can use the prop `showUserPreferences` on the `Popov
Notification center is not loading properly -Possible causes of not loading notification center properly +Possible causes for the notification center not loading properly: - Invalid subscriberId - Invalid applicationIdentifier diff --git a/docs/docs/platform/subscribers.md b/docs/docs/platform/subscribers.md index 738d4acd378..32fc2f70840 100644 --- a/docs/docs/platform/subscribers.md +++ b/docs/docs/platform/subscribers.md @@ -93,5 +93,5 @@ Novu manages a data model to help your users configure their preferences in an e
How to get subscriber properties before step execution in workflow -

Workflow has access to all existing properties of subscriber as well as payload variables. So there is no any extra step needed

+

Workflow has access to all existing properties of subscriber as well as payload variables. So no extra steps are needed