Merge pull request novuhq#2400 from jainpawan21/fix/add-faq-subscriber

feat: add few faqs

docs/docs/channels/push/fcm.md

@@ -52,3 +52,9 @@ await novu.subscribers.setCredentials('subscriberId', PushProviderIdEnum.FCM, {
   deviceTokens: ['token1', 'token2'],
 });
 ```
+
+:::info
+
+Novu uses FCM version V1
+
+:::

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?
+<details>
+<summary> What are the dependencies required to run Novu. </summary>
 
 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?
+</details>
+
+<details>
+<summary>How do I customize messages on Novu?</summary>
 
 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).
+
+</details>
+
+<details>
+<summary>Is creating and switching to a new organization deactivates the other organizations?</summary>
+
+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.
+
+</details>
+
+<details>
+<summary>Is is possible to have multiple active providers per channel</summary>
+
+Multiple active providers are only supported in [push](../channels/push) and [chat](../channels/chat) channels.
+
+</details>

docs/docs/notification-center/angular-component.md

@@ -12,6 +12,10 @@ The `@novu/notification-center-angular` package provides an Angular component wr
 npm install @novu/notification-center-angular
 ```
 
+:::note
+Novu supports Angular version >0.15.0.
+:::
+
 ## Example usage
 
 Module:
@@ -59,3 +63,7 @@ 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 <i>@types/react</i> as dev dependency for the angular component to work properly
+:::

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
+
+<details>
+ <summary> Notification center is not loading properly</summary>
+
+Possible causes for the notification center not loading properly:
+
+- Invalid subscriberId
+- Invalid applicationIdentifier
+- Invalid backendUrl (in case of self hosted)
+- Invalid socketUrl (in case of self hosted)
+
+</details>
+
+<details>
+ <summary>There is render error due to Notification center</summary>
+
+Notification center should be wrapped in <code>NovuProvider</code>
+
+</details>

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.

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.
 

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
+
+<details>
+  <summary>How to store custom properties in subscriber</summary>
+  <p>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 <a href="./templates#variable-usage"> here </a>.</p>
+</details>
+
+<details>
+  <summary>How to get subscriber properties before step execution in workflow</summary>
+  <p>Workflow has access to all existing properties of subscriber as well as payload variables. So no extra steps are needed</p>
+</details>