Skip to content

Commit

Permalink
Merge pull request #533 from novuhq/fix/help-center-grammar
Browse files Browse the repository at this point in the history
fix: help center docs grammar
  • Loading branch information
jainpawan21 committed Mar 2, 2024
2 parents 20ee579 + 0d32698 commit 1951e47
Show file tree
Hide file tree
Showing 10 changed files with 92 additions and 84 deletions.
27 changes: 13 additions & 14 deletions help/account-management.mdx
Expand Up @@ -4,31 +4,30 @@ sidebarTitle: "Account Management"
icon: "user"
---

### How to create a new Novu account?
### Creating an account

Novu has [US](https://web.novu.co/auth/signup) and [EU](https://eu.web.novu.co/auth/signup) regions. In both the regions, a new account can be created using Github or Email and Password. If you are looking for other ways to signup on Novu, feel free to reach out us at support@novu.co
Novu supports [US](https://web.novu.co/auth/signup) and [EU](https://eu.web.novu.co/auth/signup) regions based on where you want your data to be stored. In both the regions, a new account can be created using Github or Email and Password. If you are looking for other ways to signup on Novu, feel free to reach out us at support@novu.co.

### How to reset account password?
### Resetting password

If you have created an account with Novu before, you can reset your password by clicking on `Forgot Your Password?` option in sign-in page.
If you have created an account with Novu before, you can reset your password by clicking on `Forgot Your Password?` option on the sign-in page.

### Is US and EU account data synced?

No. US and EU accounts are completely independent. If you have created an account in US, you will not be able to login with the same credentials in EU and vice versa.
US and EU accounts are completely independent. If you have created an account in the US, you will not be able to login with the same credentials in the EU and vice versa.

### How to change account email?
### Changing the email associated to my account
If you want to change your account email, please reach out to us at support@novu.co.

We are working on account management feature currently so this option is not available in UI as of now. If you want to change your account email, please reach out to us at support@novu.co.
### What happens if I change my Github account email?

### What happens when github account email is changed?
If you created your Novu account using Github, and you change your email in Github, it will not be reflected in Novu. When you login to Novu using the new Github email, a new account will be created. Please email support@novu.co to update your email address.

If you have created an account using Github, and you change your email in Github, it will not be reflected in Novu. On login with same github account but having different email, a new account will be created in Novu.
### How do I create a new Organization?

### How to create new organization?
A new organization can be created by entering a value in the dropdown in the left bottom corner of the dashboard. As soon as you start writing something, an add option will appear. This dropdown can also be used to switch between organizations. One organization's data is not visible to other organization members.

A new organization can be created by writing something in the dropdown in the left bottom corner of the dashboard. As soon you start writing something, an add option will apear. This dropdown can also be used to switch between organizations. One organization's data is not visible to other organization members.

### How to change organization name?
We are working on account management feature currently so this option is not available in UI as of now. If you want to change your current organization name, [rename organization api](/api-reference/organizations/rename-organization) can be used. if you face any issue in using api or need any help any changing the organization name, please reach out to us at support@novu.co.
### How can I change the name of my Organization
If you want to change your current Organization name, [rename organization api](https://novu-preview.mintlify.app/api-reference/organizations/rename-organization) can be used. If you face any issue in using the API or need any help changing the Organization name, please reach out to us at support@novu.co.

<Snippet file="contact-support.mdx" />
4 changes: 2 additions & 2 deletions help/channels/chat.mdx
Expand Up @@ -4,7 +4,7 @@ sidebarTitle: "Chat"
icon: "comment"
---

### How to send message to a specific user on slack?
While installin the slack app, app will ask for the user or channel to which message needs to be sent. On selecting a user, webhookUrl for that user will generated and novu will use that webhookUrl to send message to that user.
### Can I send a message to a specific user on Slack?
While installing the Slack app, you will be asked the User or Channel to which the message needs to be sent. On selecting a user, a webhookUrl for that user will be generated and Novu will use that webhookUrl to send a message to that specific user.

<Snippet file="contact-support.mdx" />
24 changes: 12 additions & 12 deletions help/channels/email.mdx
Expand Up @@ -4,25 +4,25 @@ sidebarTitle: "Email"
icon: "envelope"
---

### How to override default values of email step?
All values such as from, to, subject, body, etc. can be overridden by using the `overrides` option while triggering the workflow. Check [email overrides documentation](/channels-and-providers/email/overview#sending-email-overrides) for more details.
### How to override default values of Email?
All values (from, to, subject, body, etc.) can be overridden by using the `overrides` option while triggering the workflow. Please see our [email overrides documentation](/channels-and-providers/email/overview#sending-email-overrides) for more details.

### How to send html as value of variable?
### Sending HTML as the value of a variable
HTML content as a value of step variable can be sent by replacing the double curly braces `{{}}` variable with triple curly braces `{{{}}}` variable. For example, `{{{htmlContent}}}`.

### I have multiple email integrations active, how to attach one integration with one workflow?
There can be more than one active email integrations of same or different providers. However only one email integration can be primary at one time per environment. To use different email integration than primary integration, integrationIdentifier field of email overrides can be used. Read using [different email integration](/channels-and-providers/email/overview#using-different-email-integration) for more details.
### I have multiple Email Providers or integrations active, how do I associate them to a Workflow?
There can be more than one active email integrations of same or different providers. However only one email integration can be primary at one time per environment. To use a different email integration than your primary integration, the integrationIdentifier field of email overrides can be used. Read about using [different email integration](/channels-and-providers/email/overview#using-different-email-integration) for more details.

### What could be the reason of message content could not be generated error?
This error occurs when the html content is not properly formatted. Make sure the html content is properly formatted and does not contain any syntax errors. Make sure step variables are properly formatted and are not missing opening or closing curly braces.
### Why am I getting the error “message content could not be generated?
This error occurs when the HTML content is not properly formatted. Make sure the HTML content is properly formatted and does not contain any syntax errors. Make sure Step Variables are properly formatted and are not missing opening or closing curly braces.

### Can email, phone be used as step variables?
Novu recommends not to use subscriber attributes as step variables. Instead, use the subscriber attributes directly in the step. For example, use `{{subscriber.email}}` instead of `{{email}}` as step variable. Novu will pick email from subscriber attributes and inject the value in the content.
### Can email or phone be used as step variables?
Novu recommends not to use subscriber attributes as step variables. Instead, use the subscriber attributes directly in the step. For example, use `{{subscriber.email}}` instead of `{{email}}` as your step variable. Novu will select the email from subscriber attributes and inject the value in the content.

### How to use providers templates in place of email content?
Currently, we support external provuder template support for [sendgrid](/channels-and-providers/email/sendgrid#using-sendgrid-template) and [mailersend](/channels-and-providers/email/mailersend#using-mailersend-template) only.
### How to use Provider templates in place of email content?
Currently, we support external Provider template support for [sendgrid](/channels-and-providers/email/sendgrid#using-sendgrid-template) and [mailersend](/channels-and-providers/email/mailersend#using-mailersend-template) only.

### How to retrive only email content?
### Can I retrieve only Email content?
Novu does not have a separate API to retrieve email content. However, email content can be retrieved from the email step of the workflow. The email step contains the email content in the `content` field of [get worklfow api](/api-reference/workflows/get-workflow) response.

<Snippet file="contact-support.mdx" />
20 changes: 12 additions & 8 deletions help/channels/in-app.mdx
Expand Up @@ -4,16 +4,20 @@ sidebarTitle: "In App"
icon: "bell"
---

### How to create two apps in one account?
Novu in-app channel requires you to enable in-app integration from integration store. To display in-app notifications to users, any of our [client library](/notification-center/introduction) can be used. Every library requires `applicationIdentifier` and `subscriberId` to fetch notifications. Currently, only one `applicationIdentifier` is supported per environment per organization. Feel free to reach out to us at support@novu.co if you have speicific requirements of multiple `applicationIdentifier` per organization.
### Creating two In-App Notification Centers in one account
To configure your In-App notifications, you must use the In-App integration from our integration store.

### On clicking the notification, it is not redirecting to the redirect url.
To redirect to specified redirect url on clicking the in-app notification, notification click event should be handled in client side code. Checkout [react](/notification-center/client/react/get-started#onnotificationclick) example for this.
To display in-app notifications to users, any SDKs in our [client library](/notification-center/introduction) can be used. Every library requires `applicationIdentifier` and `subscriberId` to fetch notifications. Currently, only one `applicationIdentifier` is supported per environment per organization.

### How to chaange default colors of notification center?
Styling of in-app notification center can be customized using [styles](/notification-center/client/react/customization#customization-using-styles-prop) prop. If you want to customize only single component, you can customize using [available](/notification-center/client/react/customization#popovernotificationcenter-customization) props.
Feel free to reach out to us at support@novu.co if you have speicific requirements of multiple `applicationIdentifier` per organization.

### How to secure the in-app notification center?
If someone has subscriberId and applicationIdentifier, then that person can access that subscriber's notifications. To add an extra layer of security, we have HMAC encryption feature which can be used to secure the in-app notification center. Checkout [HMAC](/notification-center/client/react/get-started#hmac-encryption) section for more details.
### Issues with a redirect URL
To redirect to specified redirect url on clicking the in-app notification, notification click event should be handled in client side code. Here is an example in [React](/notification-center/client/react/get-started#onnotificationclick).

### Changing the default colors of the Notification Center
Styling of your In-App Notification Center can be customized using the [styles](/notification-center/client/react/customization#customization-using-styles-prop) prop. If you want to customize only a single component, you can use [available](/notification-center/client/react/customization#popovernotificationcenter-customization) props.

### Additional Security for In-App Notifications
To add an extra layer of security, we recommend using our HMAC encryption feature to eliminate subscriber impersonation Checkout [HMAC](/notification-center/client/react/get-started#hmac-encryption) section for more details.

<Snippet file="contact-support.mdx" />
12 changes: 6 additions & 6 deletions help/channels/push.mdx
Expand Up @@ -4,18 +4,18 @@ sidebarTitle: "Push"
icon: "mobile"
---

### Is desktop push notification supported?
Yes, desktop push notification can be sent using web push notification. It is supported with almost all [push channel](/channels-and-providers/push/overview) providers.
### Can I send a Desktop Push notification?
Yes, Desktop Push Notifications can be sent by using a Web Push Notification. It is supported with almost all [push channel](/channels-and-providers/push/overview) providers.

### How to fix unexpected provider error with fcm provider.
Few possible reasons for this error are:
### Why am I getting the error “unexpected provider” with FCM?
The possible reasons for this error are:
- Invalid FCM credentials.
- Invalid or stale FCM token.

### How to fix Sending message failed due to Requested entity was not found error with fcm provider.
### Why am I getting the error “Sending message failed due to Requested entity was not foundwith FCM?
- This error occurs when the FCM token is invalid or stale. You can fix this by updating the FCM device token.

### How to store device tokens for particular fcm integration in case multiple active fcm provider integrations.
### Can I store device tokens for particular FCM integration if I have multiple FCM providers active?
- Device tokens for particular FCM integration can be stored using the `integrationIdentifier` field of [update subscriber credentials api](/api-reference/subscribers/update-subscriber-credentials). `integrationIdentifier` is the unique identifier of the integration which is similar to `providerIdentifier`. It can be copied from the integration form.

<Snippet file="contact-support.mdx" />
8 changes: 5 additions & 3 deletions help/channels/sms.mdx
Expand Up @@ -4,11 +4,13 @@ sidebarTitle: "SMS"
icon: "message-sms"
---

### How to fix subscriber does not have a configured channel error?
This error occurs when subscriber is missing `phone` attribute. To fix this error, you need to add update the subscriber and set the `phone` attribute with a valid phone number.
### Why am I getting the error “ subscriber does not have a configured channel?
This error occurs when a Subscriber is missing `phone` attribute. To fix this error, you need to update the subscriber and set the `phone` attribute with a valid phone number.

### How to change the default sender name for SMS?
Make sure custom sendername (sender id or from) is allowed with providers. Few counties expect to verify the sendername before using it. You can change the default sender name for SMS by using [overrides](/channels-and-providers/sms/overview#sending-sms-overrides) field while triggering the workflow.
First, ensure a custom sendername (sender id or from) is allowed with your Provider. Some countries expect to verify the sender name before using it.

You can change the default sender name for SMS by using [overrides](/channels-and-providers/sms/overview#sending-sms-overrides) field while triggering the workflow.


<Snippet file="contact-support.mdx" />
23 changes: 12 additions & 11 deletions help/content-management.mdx
@@ -1,21 +1,22 @@
---
title: "Content Management"
sidebarTitle: "Content Management"
icon: "file-pen"
---

### what is layout and how to use layouts?
Layouts are like style container for email templates. Layout can be used for organization branding and style. It can be used to define the structure of the email template. It can be used to define the header, footer, and other common elements. It must have `{{{body}}}` variable which will be replaced by the actual email template content.
### What is a Layout and how can I use them?
Layout is similar to a style container for email templates. Layouts can be used for your organization’s branding and style. It can be used to define the structure of the email template such as the header, footer, and other common elements. It must have a `{{{body}}}` variable which will be replaced by the actual email template content.

### Can layout be used in all channels?
No, layout can be used only in email channel.
### Can Layouts be used across all channels?
Layouts are specific to Emails.

### Can mjml templates be used in content editors?
No, only html templates can be used in content editors. We support [handlebar helpers](/content-creation-design/handlebars-helpers) for common usecase like iteration, conditions etc. If you need any specific handlebar helpers, please reach out to us at support@novu.co
### Can MJML templates be used in content editors?
Only HTML templates can be used in content editors. We support [handlebar helpers](/content-creation-design/handlebars-helpers) for common use cases like iteration, conditions etc. If you need any specific Handlebar Helpers, please reach out to us at support@novu.co.

### Can one step content be reused in another step?
No, currently each step content is separate and cannot be reused.

### Which translation will be used if subscriber's locale field does not match with translation language files?
If subscriber's locale field does not match with translation locale files, or it is not available, then default language of translation group will be used.
### Can the content of one Step be used in another?
Currently each Step has content that is unique to it and can not be reused. If this is important to you, please send us a note at support@novu.co.

### Which Translation Language will be used if the Subscriber’s locale field does not match with translation language files?
If the Subscriber's locale field does not match with Translation locale files, or it is not available, then the defaul language of the translation group will be used. If a default is not set, the automatic fallback is English.

<Snippet file="contact-support.mdx" />

0 comments on commit 1951e47

Please sign in to comment.