Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: help center to main #535

Merged
merged 47 commits into from Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
df3a2ac
fix: segment guide was using an index already being used by headless …
sumitsaurabh927 Feb 6, 2024
db8353e
fix: add back tick on env variables
jainpawan21 Feb 14, 2024
bc21d82
docs: add fcm react native guide
sumitsaurabh927 Feb 16, 2024
b10b672
docs: remove sidebar icons for all the guides
sumitsaurabh927 Feb 16, 2024
1a64138
docs: guide done
sumitsaurabh927 Feb 16, 2024
af72050
docs: add link to repo
sumitsaurabh927 Feb 16, 2024
ac21bfc
update code of conduct
unicodeveloper Feb 22, 2024
393961e
add notes
unicodeveloper Feb 22, 2024
be3e7a3
Merge pull request #526 from novuhq/update-for-community
unicodeveloper Feb 22, 2024
06bc0e7
feat: add help center section
jainpawan21 Feb 25, 2024
3b9c592
feat: add account management questions
jainpawan21 Feb 25, 2024
bf95fc4
feat: add user management questions
jainpawan21 Feb 25, 2024
f4da494
feat: add content management 2 questions
jainpawan21 Feb 26, 2024
16ed217
fix: add payload filter option in headless
jainpawan21 Feb 26, 2024
5836b9c
fix: add missing commas
jainpawan21 Feb 26, 2024
4801d0d
Merge pull request #528 from novuhq/fix/add-payload-in-headless
jainpawan21 Feb 26, 2024
470bc25
fix: file URL
sumitsaurabh927 Feb 26, 2024
92466fa
fix: add missing import statement
sumitsaurabh927 Feb 26, 2024
737ac37
Merge pull request #525 from novuhq/fcm-rn-android
sumitsaurabh927 Feb 26, 2024
cb28ea6
feat: added icons
jainpawan21 Feb 27, 2024
95967d7
feat: add account management answers
jainpawan21 Feb 27, 2024
8f5fd94
feat: add user management answers
jainpawan21 Feb 27, 2024
49c6919
feat: add initial content management questions and answers
jainpawan21 Feb 27, 2024
bd5d544
feat: add push channel questions and answers
jainpawan21 Feb 27, 2024
96e1e9d
feat: add email q n a
jainpawan21 Feb 27, 2024
204f3fb
feat: add channels titles
jainpawan21 Feb 27, 2024
8e7609d
fix: frameborder warning
jainpawan21 Feb 28, 2024
1fd7264
feat: add contact support snippet
jainpawan21 Feb 28, 2024
326bb9c
feat: add in-app questions
jainpawan21 Feb 28, 2024
8f5cd85
feat: add sms channel question
jainpawan21 Feb 28, 2024
62fa649
feat: add orchestration questions
jainpawan21 Feb 28, 2024
fe15bf6
fix: remove repeated video link
jainpawan21 Feb 28, 2024
4d25e2c
fix: typo mistakes
jainpawan21 Feb 28, 2024
696425e
Merge pull request #529 from novuhq/feat/help-center
jainpawan21 Feb 28, 2024
aa603ec
Update fcm.mdx
JamesMcClelland Feb 29, 2024
20ee579
Merge pull request #530 from JamesMcClelland/patch-1
jainpawan21 Mar 1, 2024
cab383f
Add AWS EC2 deployment information to Novu documentation
Cliftonz Mar 1, 2024
1184767
fix: add account management grammar
jainpawan21 Mar 1, 2024
c76fe05
fix: observability page
jainpawan21 Mar 1, 2024
ad7773e
fix: content management page
jainpawan21 Mar 1, 2024
fea203d
fix: in-app and email words
jainpawan21 Mar 2, 2024
0d32698
fix: chat, sms and push words
jainpawan21 Mar 2, 2024
1951e47
Merge pull request #533 from novuhq/fix/help-center-grammar
jainpawan21 Mar 2, 2024
a0c037d
Merge pull request #532 from novuhq/ec2-deployment
jainpawan21 Mar 2, 2024
06c42ca
Merge pull request #520 from novuhq/fix/gcp-storag
jainpawan21 Mar 2, 2024
79caac2
fix: add product architeture image
jainpawan21 Mar 4, 2024
5b9c829
Merge pull request #534 from novuhq/feature/product-architecture
jainpawan21 Mar 4, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions _snippets/contact-support.mdx
@@ -0,0 +1,3 @@
<Info>
If your question is not answered here, feel free to reach out us at support@novu.co
</Info>
7 changes: 3 additions & 4 deletions additional-resources/posts-videos-and-articles.mdx
Expand Up @@ -10,10 +10,9 @@ description: 'Blog posts, articles, and videos'
- [Creating A Hot New Food Delivery App with Novu](https://dev.to/novu/creating-a-hot-new-food-delivery-app-with-novu-2e75)

## Videos
- [How to add In-App Notifications to your Web app with Novu](https://www.youtube.com/watch?v=KD8zoUb132k)
- [Subscriber (User) Management & Bulk Import Guide](https://www.youtube.com/watch?v=m5nhYEuz86I&t=92s)
- [Workflow Optimization with Delay Actions](https://www.youtube.com/watch?v=kCMB-WdbzJo)
- [Workflow Optimization with Delay Actions](https://www.youtube.com/watch?v=kCMB-WdbzJo)
- [How to add In-App Notifications to your Web app with Novu](https://www.youtube.com/watch?v=KD8zoUb132k)
- [Subscriber (User) Management & Bulk Import Guide](https://www.youtube.com/watch?v=m5nhYEuz86I&t=92s)
- [Workflow Optimization with Delay Actions](https://www.youtube.com/watch?v=kCMB-WdbzJo)

## External Resources
- [Simplify configuration management with Novu and Configu](https://configu.com/blog/video-first-steps-with-configu/)
Expand Down
2 changes: 1 addition & 1 deletion channels-and-providers/chat/overview.mdx
Expand Up @@ -6,7 +6,7 @@ description: 'Learn the process of configuring and using chat providers with Nov

Novu can be used to deliver chat messages to your customers using a unified delivery API. You can easily integrate your favorite chat provider using the built-in integration store.

<iframe src="https://www.loom.com/embed/09ab7cc396e544beb17df541e2584d7e" width="100%" height="400px" frameborder="0" allowFullScreen></iframe>
<iframe src="https://www.loom.com/embed/09ab7cc396e544beb17df541e2584d7e" width="100%" height="400px" frameBorder="0" allowFullScreen></iframe>

## Configuring chat providers

Expand Down
2 changes: 1 addition & 1 deletion channels-and-providers/email/overview.mdx
Expand Up @@ -5,7 +5,7 @@ description: 'Learn the process of configuring email providers with Novu'

Novu can be used to deliver email messages to your customers using a unified delivery API. You can easily integrate your favorite email provider using the built-in integration store.

<iframe src="https://www.loom.com/embed/dbe39c7fc0aa42c8b39bea73d8aee9a4" width="100%" height="400px" frameborder="0" allowFullScreen></iframe>
<iframe src="https://www.loom.com/embed/dbe39c7fc0aa42c8b39bea73d8aee9a4" width="100%" height="400px" frameBorder="0" allowFullScreen></iframe>

## Configuring email providers

Expand Down
2 changes: 1 addition & 1 deletion channels-and-providers/in-app/introduction.mdx
Expand Up @@ -23,7 +23,7 @@ In-app notifications are messages or alerts that appear within a mobile app or w

## In-app notifications using Novu

<iframe src="https://www.loom.com/embed/e1a6a16b024a408eafb15dfcc2d2e0c3" width="100%" height="400px" frameborder="0" allowFullScreen></iframe>
<iframe src="https://www.loom.com/embed/e1a6a16b024a408eafb15dfcc2d2e0c3" width="100%" height="400px" frameBorder="0" allowFullScreen></iframe>

Novu provides a pre built component to display in-app notifications for almost all web frameworks. You can use this component to display in-app notifications in your web app. If you don't want to use the pre built component, you can use the headless component to build your own in-app notification center. Read more about notification center [here](/notification-center/introduction).

Expand Down
9 changes: 7 additions & 2 deletions channels-and-providers/push/fcm.mdx
Expand Up @@ -63,7 +63,7 @@ import {
const novu = new Novu("<NOVU_API_KEY>");

await novu.subscribers.setCredentials('subscriberId', PushProviderIdEnum.FCM, {
deviceTokens: ['token1', 'token2'],
deviceTokens: ['token1', 'token2'],
});

````
Expand All @@ -76,7 +76,12 @@ curl -L -X PUT 'https://api.novu.co/v1/subscribers/<SUBSCRIBER_ID>/credentials'
-H 'Authorization: ApiKey <NOVU_API_KEY>' \
-d '{
"providerId": "fcm",
"deviceTokens": ["token1", "token2"],
"credentials": {
"deviceTokens" : [
"token1",
"token2"
]
},
"integrationIdentifier": "fcm-MnGLxp8uy"
}'
````
Expand Down
2 changes: 1 addition & 1 deletion channels-and-providers/sms/overview.mdx
Expand Up @@ -6,7 +6,7 @@ description: "Learn the process of configuring and using sms providers with Novu

Novu can be used to deliver sms messages to your customers using a unified delivery API. You can easily integrate your favorite sms provider using the built-in integration store.

<iframe src="https://www.loom.com/embed/1d12bede8bf5482185ac626c2130cf33" width="100%" height="400px" frameborder="0" allowFullScreen></iframe>
<iframe src="https://www.loom.com/embed/1d12bede8bf5482185ac626c2130cf33" width="100%" height="400px" frameBorder="0" allowFullScreen></iframe>

## Configuring SMS providers

Expand Down
51 changes: 26 additions & 25 deletions community/code-of-conduct.mdx
@@ -1,5 +1,5 @@
---
title: "Code of conduct"
title: "Novu Community Code of conduct"
description: "The set of rules and guidelines that govern interaction among community members"
---

Expand All @@ -26,7 +26,6 @@ It's crucial to keep in mind that our community members are from all kinds of ba
- Accept responsibility and apologise to those affected by mistakes, and learn from such experiences
- Focus on what is best not just for us as individuals, but for the overall community!



### Patience

Expand All @@ -50,7 +49,7 @@ Avoid assumptions about others' backgrounds. Maintain a positive and professiona

We encourage our users to ask early and ask often. Rather than asking whether you can ask a question (the answer is always yes!), instead, simply ask your question. You are encouraged to provide as many specifics as possible.

Code snippets in the form of images are bad practice. Instead, use text formatted as code (using backticks) on Discord or simply send a gist. Refrain from pasting multiple lines of code directly into the chat channels - instead use [gists](http://gist.github.com/) or some other tool to provide code snippets.
Code snippets in the form of images are bad practice. Instead, use text formatted as code (using backticks) on Discord or simply send a gist. Refrain from pasting multiple lines of code directly into the chat channels - instead use [gist.github.com](http://gist.github.com/) or another paste site to provide code snippets.

### Helpful

Expand All @@ -60,7 +59,7 @@ Avoid sarcastic responses and prioritize useful information. Everyone should rea

### Anti-harassment policy

Harassment includes (but is not limited to) all of the following behaviours:
Harassment includes (but is not limited to) all of the following behaviors:

- Offensive comments related to gender (including gender expression and identity), age, sexual orientation, disability, physical appearance, body size, race, and religion.
- Derogatory terminology including words commonly known to be slurs
Expand All @@ -78,7 +77,7 @@ Continuing inappropriate behaviour after being asked to stop constitutes harassm

### Reporting policy violations

Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to anyone with administrative power in the community (Admins or Moderators on Discord, members of the ‘DevRel’* role), or to the local organizers of an event or to [support@novu.co](mailto:support@novu.co). Meetup organizers are encouraged to prominently display points of contact for reporting unacceptable behaviour at local events.
Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to anyone with administrative power in the community (Admins or Moderators on Discord, members of the ‘DevRel’ role), or to the local organizers of an event or to [support@novu.co](mailto:support@novu.co). Meetup organizers are encouraged to prominently display points of contact for reporting unacceptable behaviour at local events.

If a participant engages in harassing behaviour, the meetup organizers may take any action they deem appropriate. These actions may include but are not limited to warning the offender, expelling the offender from the event, and barring the offender from future community events.

Expand All @@ -90,31 +89,33 @@ We expect all participants, organizers, speakers, and attendees to follow these

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

1. Correction
- Community Impact: Use of inappropriate language or other behaviour deemed unprofessional or unwelcome in the community.
- Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behaviour was inappropriate. A public apology may be requested.
2. Warning
- Community Impact: A violation through a single incident or series of actions.
- Consequence: A warning with consequences for continued behaviour. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
3. Temporary Ban
- Community Impact: A serious violation of community standards, including sustained inappropriate behaviour.
- Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
4. Permanent Ban
- Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behaviour, harassment of an individual, or aggression toward or disparagement of classes of individuals.
- Consequence: A permanent ban from any sort of public interaction within the community.
1. **Correction**
- `Community Impact`: Use of inappropriate language or other behaviour deemed unprofessional or unwelcome in the community.
- `Consequence`: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behaviour was inappropriate. A public apology may be requested.
2. **Warning**
- `Community Impact`: A violation through a single incident or series of actions.
- `Consequence`: A warning with consequences for continued behaviour. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
3. **Temporary Ban**
- `Community Impact`: A serious violation of community standards, including sustained inappropriate behaviour.
- `Consequence`: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
4. **Permanent Ban**
- `Community Impact`: Demonstrating a pattern of violation of community standards, including sustained inappropriate behaviour, harassment of an individual, or aggression toward or disparagement of classes of individuals.
- `Consequence`: A permanent ban from any sort of public interaction within the community.

The Novu Community Code of Conduct is licensed under the Creative Commons Attribution-Share Alike 3.0 license.

Our Code of Conduct was adapted from Codes of Conduct of other open-source projects, including:

- Contributor Covenant
- Elastic
- The Fedora Project
- OpenStack
- Ansible
- Puppet Labs
- Ubuntu
- **Contributor Covenant**
- **Elastic**
- **The Fedora Project**
- **OpenStack**
- **Ansible**
- **Puppet Labs**
- **Ubuntu**

Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.

For answers to common questions about this code of conduct, see the FAQ [here.](https://www.contributor-covenant.org/faq) <br/>Translations are [also available here.](https://www.contributor-covenant.org/translations)
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq.

Translations are available at https://www.contributor-covenant.org/translations.
52 changes: 33 additions & 19 deletions community/get-involved.mdx
@@ -1,5 +1,5 @@
---
title: "Get involved"
title: "Get involved with the Novu Community"
description: "Your guide for engaging with the Novu community"
---

Expand All @@ -10,10 +10,12 @@ At Novu, we're a vibrant, open-source community driven by passion, collaboration
## Join the conversation

- Read our [code of conduct](/community/code-of-conduct)
- Say “Hi!” in our [Discord Server]((https://discord.gg/novu?ref=docs-community-introduction))
- Explore our [open issues]([link](https://github.com/novuhq/novu/issues))
- Say “Hi!” in our [Discord Server](https://discord.gg/novu?ref=docs-community-introduction)
- Explore our [open issues](https://github.com/novuhq/novu/issues)
- Subscribe to our newsletter [to stay in the know](https://novu.co/novu-community-2-0/?utm_campaign=Community%202.0&utm_source=Docs)

## Getting help

Our fellow community members are always ready to help you get past a blocker. However, you can take a few things into consideration to help them help you:

- Share as many details as you can share. It will help us in debugging the issue.
Expand All @@ -24,33 +26,48 @@ Our fellow community members are always ready to help you get past a blocker. Ho

<Info>Community self-host option includes only community support. Checkout [commercial self host](/self-hosting-novu/commerical-self-host) for priority support.</Info>
<Tip>Intercome is suitable if you're using Novu cloud or [commercial self-host](/self-hosting-novu/commerical-self-host) and want priority support. Kindly use Discord or Github for community self-hosting questions.</Tip>


## Contributing

All community members are of one of the following four types:

1. Open source users
2. Active users
3. Power users
2. Active member
3. Power member
4. Novu Ambassador

### Become an active community member

- Everyone who joins our community becomes an open-source user automatically.
- You can become an active user by:
- You can become an active community member by:
- Submitting >2 PRs
- Opening >2 issues
- Sending >5 messages on Github
- Commenting >3 times on Github
- Active users are one step closer to becoming Power users.
- Active community members are one step closer to becoming Power community members and then an active moderator.

### Become a power user
### Become a power community member

- All active community members are eligible to become a power user and can become so by having at least one of the following:
- All active community members are eligible to become a power community member and can become so by having at least one of the following:
- Submitting 3 PRs
- Opening 3 Issues
- Sending 10 Discord messages
- Commenting >10 times on Github
- Power community members are just one step away from becoming a Novu ambassador.

### Become a Novu Ambassador

A Novu ambassador is a trusted power member of the community that can do the following:

- Love exploring and sharing their knowledge of any technology with other developers.
- Often write and speak about Novu.
- Possess strong Novu expertise and often help and support Novu users within the community.
- Socially influence developers with some knowledge of Novu.
- Consistently contribute to Novu OSS product.

We are launching the Novu Ambassador program soon with amazing perks. Stay tuned!

<Info>The activity period is 30 days for becoming an active/power user. So, you'll be upgraded/downgraded depending on your activity in the stipulated time.</Info>

## Activities

Expand All @@ -59,7 +76,7 @@ Are you passionate about notifications like we are? There are many different—a
### Help in onboarding and answering questions.

- Welcome new users into the community
- Answer questions in the [community support channel]([link](https://discord.com/channels/895029566685462578/1019663407915483176)).
- Answer questions in the [community support channel](https://discord.com/channels/895029566685462578/1019663407915483176).
- Offer input and opinions about various solutions you have tried.

### Improve our documentation
Expand All @@ -83,7 +100,7 @@ Are you passionate about notifications like we are? There are many different—a
### Create content

- Content writers program: Apply to become a content writer with us and get paid to write about use-cases highlighting how you solved a problem using Novu
- Write an article or a social media post about what you built with Novu and tag us there to share it with the community. We’ll shout you out, promise!!!
- Write an article about what you built with Novu and share it with the community. We’ll give you a shout out!

### PRs, issues, and bug reports

Expand All @@ -95,16 +112,13 @@ Are you passionate about notifications like we are? There are many different—a

<Info>
At Novu, we believe that no contribution is small, and the only wrong question is the one that doesn’t get asked. So feel free to ask any question or raise that Pull Request. You’re always welcome here! 🤗

</Info>

### Events and announcements
Staying in tune with our upcoming community events, workshops, and hackathons is fairly easy.
- Just keep an eye out for new announcements in the [announcement](https://discord.com/channels/895029566685462578/1040040454906986578) channel in our [discord community.](https://discord.gg/novu?ref=docs-upcoming-event)That’s the best way to stay updated about new events.
- You can also subscribe our [youtube channel](https://www.youtube.com/@novuhq) and follow us on [dev.to](https://dev.to/novu).
### Participate in office hours

<br/>
- We have frequent (replace with interval— twice weekly, weekly, etc.) and topic-specific office hours that offer the ability to engage in real-time with Novu staff and other community members
- In these sessions, offer input, opinions, examples, etc. to contribute!

We’re excited to have you on board and look forward to your valuable contributions! If you need assistance, have questions, or want to share your experiences, feel free to engage with us through the support channels mentioned above.
We’re excited to have you on board and look forward to your valuable contributions!

Together, we’ll shape the future of Novu. 🫂
6 changes: 3 additions & 3 deletions community/run-in-local-machine.mdx
Expand Up @@ -17,7 +17,7 @@ Need help installing the requirements? Read more [here](/community/machine-setu

<Note>We recommend having at least 8GB of RAM to run Novu on a local machine as Novu has multiple services running together with external services like redis, mongodb etc.</Note>

<iframe src="https://www.loom.com/embed/40c5da9a8b0c4bddb100c262f6b451d4" width="100%" height="400px" frameborder="0" allowFullScreen></iframe>
<iframe src="https://www.loom.com/embed/40c5da9a8b0c4bddb100c262f6b451d4" width="100%" height="400px" frameBorder="0" allowFullScreen></iframe>

### Setup the project

Expand Down Expand Up @@ -64,9 +64,9 @@ The `npm run start` will start the Jarvis CLI tool which allows you to run the
- **start:node** - Runs the `@novu/node` package in watch mode
- **start:notification-center** - Runs and builds the React package for the Novu notification center

<iframe src="https://www.loom.com/embed/239c1b7ec057409ba6c0d55ceef82135" width="100%" height="400px" frameborder="0" allowFullScreen></iframe>
<iframe src="https://www.loom.com/embed/239c1b7ec057409ba6c0d55ceef82135" width="100%" height="400px" frameBorder="0" allowFullScreen></iframe>

<iframe src="https://www.loom.com/embed/497ed0fecfb2476a85e902365a07cbb1" width="100%" height="400px" frameborder="0" allowFullScreen></iframe>
<iframe src="https://www.loom.com/embed/497ed0fecfb2476a85e902365a07cbb1" width="100%" height="400px" frameBorder="0" allowFullScreen></iframe>

### Set up your environment variables

Expand Down
@@ -1,7 +1,6 @@
---
title: 'How to send PUSH notifications to iOS devices with FCM using Novu'
description: 'Learn how to integrate Firebase Cloud Messaging with Novu and send notifications to iOS'
icon: 'circle-7'
---

## Prerequisites
Expand Down