Merge pull request #5284 from novuhq/justnems-github-analytics

justnems-analytics-updates
novuhq · Mar 14, 2024 · 7c4fc7c · 7c4fc7c
2 parents b42fc81 + 2bfdb5d
commit 7c4fc7c
Show file tree

Hide file tree

Showing 18 changed files with 34 additions and 31 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -567,6 +567,9 @@
     "upserted",
     "upstash",
     "Upstash",
+    "usecase",
+    "USECASE",
+    "Vonage",
     "Krakend",
     "ratelimit",
     "Ratelimit",

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -56,10 +56,10 @@ You can open a new issue with this [issue form](https://github.com/novuhq/novu/i
 
 The project is a monorepo, meaning that it is a collection of multiple packages managed in the same repository.
 
-To learn more about the project structure and running the project locally, please have a look [here](https://docs.novu.co/community-support/introduction#run-novu-locally).
+To learn more about the project structure and running the project locally, please have a look [here](https://docs.novu.co/community-support/introduction#run-novu-locally?utm_campaign=github-contrib).
 After cloning your fork, you will need to run the `npm run setup:project` command to install and build all dependencies.
 
-To learn a detailed guide on running the project locally, checkout our guide on [how to run novu in local machine](https://docs.novu.co/community/run-in-local-machine).
+To learn a detailed guide on running the project locally, checkout our guide on [how to run novu in local machine](https://docs.novu.co/community/run-in-local-machine?utm_campaign=github-contrib).
 
 ## Missing a Feature?
 
@@ -86,8 +86,8 @@ Questions, suggestions, and thoughts are most welcome. Feel free to open a [GitH
 - Help create tutorials and blog posts
 - Request a feature by submitting a proposal
 - Report a bug
-- **Improve documentation** - fix incomplete or missing [docs](https://docs.novu.co/), bad wording, examples or explanations.
+- **Improve documentation** - fix incomplete or missing [docs](https://docs.novu.co/?utm_campaign=github-contrib), bad wording, examples or explanations.
 
 ## Missing a provider?
 
-If you are in need of a provider we do not yet have, you can request a new one by [submitting an issue](#submitting-an-issue). Or you can build a new one by following our [create a provider guide](https://docs.novu.co/community/add-a-new-provider).
+If you are in need of a provider we do not yet have, you can request a new one by [submitting an issue](#submitting-an-issue). Or you can build a new one by following our [create a provider guide](https://docs.novu.co/community/add-a-new-provider?utm_campaign=github-contrib).
diff --git a/README.md b/README.md
@@ -105,7 +105,7 @@ npx novu init
 
 After setting up your account using the cloud or docker version, you can trigger the API using the `@novu/node` package.
 
-For API documentation and reference, please visit [Novu API Reference] (https://docs.novu.co/api-reference/events/trigger-event).
+For API documentation and reference, please visit [Novu API Reference] (https://docs.novu.co/api-reference/events/trigger-event?utm_campaign=github-readme).
 
 To get started with the Node.js package, you can install it using npm:
 
@@ -148,7 +148,7 @@ Create notification workflows right from your IDE and integrate with MJML/React
 - Define workflow and step validations with Zod or JSON Schema
 - Modify content and behavior via Web management input panel
 
-[Request Early Access](https://novu.co/novu-echo-coming-soon/?utm_campaign=echo_github)
+[Request Early Access](https://novu.co/novu-echo-coming-soon/?utm_campaign=github-readme)
 
 ```ts
 
@@ -202,17 +202,17 @@ client.workflow('comment-on-post', async ({step, subscriber}) => {
 
 ## Embeddable Notification Center
 
-Using the Novu API and admin panel, you can easily add a real-time notification center to your web app without building it yourself. You can use our [React](https://docs.novu.co/notification-center/client/react/get-started) / [Vue](https://docs.novu.co/notification-center/client/vue) / [Angular](https://docs.novu.co/notification-center/client/angular) components or an [iframe embed](https://docs.novu.co/notification-center/client/iframe), as well as a [Web component](https://docs.novu.co/notification-center/client/web-component).
+Using the Novu API and admin panel, you can easily add a real-time notification center to your web app without building it yourself. You can use our [React](https://docs.novu.co/notification-center/client/react/get-started?utm_campaign=github-readme) / [Vue](https://docs.novu.co/notification-center/client/vue?utm_campaign=github-readme) / [Angular](https://docs.novu.co/notification-center/client/angular?utm_campaign=github-readme) components or an [iframe embed](https://docs.novu.co/notification-center/client/iframe?utm_campaign=github-readme), as well as a [Web component](https://docs.novu.co/notification-center/client/web-component?utm_campaign=github-readme).
 
 <div align="center">
 <img width="762" alt="notification-center-912bb96e009fb3a69bafec23bcde00b0" src="https://user-images.githubusercontent.com/80174214/193887395-f1c95042-b4e6-480e-a89c-a78aa247fa90.gif" alt-text="GIF of Novu's Embeddable Notification Center">
 
-Read more about how to add a notification center to your app with the Novu API [here](https://docs.novu.co/notification-center/getting-started)
+Read more about how to add a notification center to your app with the Novu API [here](https://docs.novu.co/notification-center/getting-started?utm_campaign=github-readme)
 
 <p align="center">
-  <a href="https://docs.novu.co/sdks/react">React Component</a>
-  · <a href="https://docs.novu.co/sdks/vue">Vue Component</a>
-  · <a href="https://docs.novu.co/sdks/angular">Angular Component</a>
+  <a href="https://docs.novu.co/sdks/react?utm_campaign=github-readme">React Component</a>
+  · <a href="https://docs.novu.co/sdks/vue?utm_campaign=github-readme">Vue Component</a>
+  · <a href="https://docs.novu.co/sdks/angular?utm_campaign=github-readme">Angular Component</a>
   </p>
 
 </div>
@@ -277,7 +277,7 @@ Novu provides a single API to manage providers across multiple channels with a s
 
 #### 📱 In-App
 
-- [x] [Novu](https://docs.novu.co/notification-center/getting-started)
+- [x] [Novu](https://docs.novu.co/notification-center/getting-started?utm_campaign=github-readme)
 - [ ] MagicBell
 
 #### Other (Coming Soon...)
@@ -298,9 +298,9 @@ We are more than happy to help you. If you are getting any errors or facing prob
 
 ## 🔗 Links
 
-- [Home page](https://novu.co?utm_source=github)
+- [Home page](https://novu.co?utm_campaign=github-readme)
 - [Contribution Guidelines](https://github.com/novuhq/novu/blob/main/CONTRIBUTING.md)
-- [Run Novu Locally](https://docs.novu.co/community/run-in-local-machine)
+- [Run Novu Locally](https://docs.novu.co/community/run-in-local-machine?utm_campaign=github-readme)
 
 ## 🛡️ License
 

diff --git a/apps/api/README.md b/apps/api/README.md
@@ -27,7 +27,7 @@ The command will return warnings and errors that must be fixed before the Github
 
 ## Running the API
 
-See the docs for [Run in Local Machine](https://docs.novu.co/community/run-in-local-machine) to get setup. Then run:
+See the docs for [Run in Local Machine](https://docs.novu.co/community/run-in-local-machine?utm_campaign=github-api-readme) to get setup. Then run:
 
 ```bash
 # Run the API in watch mode
@@ -43,7 +43,7 @@ $ npm run test
 ```
 
 ### E2E tests
-See the docs for [Running on Local Machine - API Tests](https://docs.novu.co/community/run-in-local-machine#api).
+See the docs for [Running on Local Machine - API Tests](https://docs.novu.co/community/run-in-local-machine#api?utm_campaign=github-api-readme).
 
 ## Migrations
 Database migrations are included for features that have a hard dependency on specific data being available on database entities. These migrations are run by both Novu Cloud and Novu Self-Hosted users to support new feature releases.

diff --git a/apps/api/jarvis-api-intro.md b/apps/api/jarvis-api-intro.md
@@ -11,7 +11,7 @@ This issue was tagged as related to `@novu/api` and the related code is located
   If that's the first time you want to contribute to Novu here are a few simple steps to get you started:
   1. Fork the repository and clone your fork to your local machine.
   2. Install the dependencies using `npm run setup:project`.
-  3. Create a new branch with the number of the issue, for example: `1454-fix-something-cool` and start contributing based on the [Contributing Guide](https://docs.novu.co/community/run-in-local-machine) or the short guide in the section below.
+  3. Create a new branch with the number of the issue, for example: `1454-fix-something-cool` and start contributing based on the [Contributing Guide](https://docs.novu.co/community/run-in-local-machine?utm_campaign=github-jarvis) or the short guide in the section below.
   4. Create a Pull request and follow the template of creation 
 </details>
 

diff --git a/apps/web/cypress/tests/digest-playground.spec.ts b/apps/web/cypress/tests/digest-playground.spec.ts
@@ -16,7 +16,7 @@ describe('Digest Playground Workflow Page', function () {
     cy.url().should('include', '/digest-playground');
     cy.contains('Digest Workflow Playground');
 
-    cy.get('a[href="https://docs.novu.co/workflows/digest?utm_campaign=in-app"]').contains('Learn more in docs');
+    cy.get('a[href^="https://docs.novu.co/workflows/digest"]').contains('Learn more in docs');
   });
 
   it('the set up digest workflow should redirect to template edit page', function () {

diff --git a/apps/web/cypress/tests/integrations-list-modal.spec.ts b/apps/web/cypress/tests/integrations-list-modal.spec.ts
@@ -773,7 +773,7 @@ describe('Integrations List Modal', function () {
       'Select a framework to set up credentials to start sending notifications.'
     );
     cy.getByTestId('update-provider-sidebar')
-      .find('a[href="https://docs.novu.co/notification-center/introduction?utm_campaign=in-app"]')
+      .find('a[href^="https://docs.novu.co/notification-center/introduction"]')
       .contains('Explore set-up guide');
     cy.getByTestId('is_active_id').should('have.value', 'true');
     cy.window().then((win) => {

diff --git a/apps/web/cypress/tests/integrations-list-page.spec.ts b/apps/web/cypress/tests/integrations-list-page.spec.ts
@@ -924,7 +924,7 @@ describe('Integrations List Page', function () {
       'Select a framework to set up credentials to start sending notifications.'
     );
     cy.getByTestId('update-provider-sidebar')
-      .find('a[href="https://docs.novu.co/notification-center/introduction?utm_campaign=in-app"]')
+      .find('a[href^="https://docs.novu.co/notification-center/introduction"]')
       .contains('Explore set-up guide');
     cy.getByTestId('is_active_id').should('have.value', 'true');
     cy.window().then((win) => {

diff --git a/apps/web/src/pages/get-started/consts/DelayUseCase.const.tsx b/apps/web/src/pages/get-started/consts/DelayUseCase.const.tsx
@@ -9,7 +9,7 @@ import { OnboardingUseCasesTabsEnum } from './OnboardingUseCasesTabsEnum';
 const USECASE_BLUEPRINT_IDENTIFIER = 'get-started-delay';
 
 export const DelayUseCaseConst: OnboardingUseCase = {
-  useCaseLink: 'https://docs.novu.co/workflows/delay-action',
+  useCaseLink: 'https://docs.novu.co/workflows/delay-action?utm_campaign=inapp-usecase-delay',
   type: OnboardingUseCasesTabsEnum.DELAY,
   title: 'Delay step execution',
   description: 'Introduces a specified time delay between workflow steps, ensuring a well-paced progression of events.',

diff --git a/apps/web/src/pages/get-started/consts/DigestUseCase.const.tsx b/apps/web/src/pages/get-started/consts/DigestUseCase.const.tsx
@@ -15,7 +15,7 @@ export const DigestUseCaseConst: OnboardingUseCase = {
   type: OnboardingUseCasesTabsEnum.DIGEST,
   description:
     'Aggregates multiple events into a single, concise message, preventing user overload with excessive notifications.',
-  useCaseLink: 'https://docs.novu.co/workflows/digest',
+  useCaseLink: 'https://docs.novu.co/workflows/digest?utm_campaign=inapp-usecase-digest',
   steps: [
     {
       title: 'Configure providers',

diff --git a/apps/web/src/pages/get-started/consts/InAppUseCase.const.tsx b/apps/web/src/pages/get-started/consts/InAppUseCase.const.tsx
@@ -16,7 +16,7 @@ export const InAppUseCaseConst: OnboardingUseCase = {
   description:
     "Utilize Novu's pre-built customizable in-app component. " +
     'Or opt for the headless library to create your own in-app notification center.',
-  useCaseLink: 'https://docs.novu.co/channels-and-providers/in-app/introduction',
+  useCaseLink: 'https://docs.novu.co/channels-and-providers/in-app/introduction?utm_campaign=inapp-usecase-inapp',
   steps: [
     {
       title: 'Configure In-App provider',

diff --git a/apps/web/src/pages/get-started/consts/MultiChannelUseCase.const.tsx b/apps/web/src/pages/get-started/consts/MultiChannelUseCase.const.tsx
@@ -15,7 +15,7 @@ export const MultiChannelUseCaseConst: OnboardingUseCase = {
     'Notifies subscribers using a wide range of channels: In-App, Email, Chat, Push, and SMS.\n' +
     '\n' +
     'Configure as many providers as you like to Customize notification experience.',
-  useCaseLink: 'https://docs.novu.co/channels-and-providers/introduction',
+  useCaseLink: 'https://docs.novu.co/channels-and-providers/introduction?utm_campaign=inapp-usecase-multichannel',
   steps: [
     {
       title: 'Configure providers',

diff --git a/apps/web/src/pages/get-started/consts/TranslationUseCase.const.tsx b/apps/web/src/pages/get-started/consts/TranslationUseCase.const.tsx
@@ -11,7 +11,7 @@ export const TranslationUseCaseConst: OnboardingUseCase = {
   description:
     'Upload translations to use them as variables or for auto-upload in the editor in a workflow. ' +
     'This feature is available for business and enterprise plan.',
-  useCaseLink: 'https://docs.novu.co/content-creation-design/translations',
+  useCaseLink: 'https://docs.novu.co/content-creation-design/translations?utm_campaign=inapp-usecase-translation',
   steps: [
     {
       title: 'Configure providers',

diff --git a/apps/web/src/pages/integrations/components/NovuInAppForm.tsx b/apps/web/src/pages/integrations/components/NovuInAppForm.tsx
@@ -131,7 +131,7 @@ export const NovuInAppForm = ({
           <CircleArrowRightStyled
             onClick={() => {
               window.open(
-                `https://docs.novu.co/notification-center/client/iframe${UTM_CAMPAIGN_QUERY_PARAM}#enabling-hmac-encryption`
+                `https://docs.novu.co/notification-center/client/iframe#enabling-hmac-encryption${UTM_CAMPAIGN_QUERY_PARAM}`
               );
             }}
           />

diff --git a/packages/cli/README.MD b/packages/cli/README.MD
@@ -89,7 +89,7 @@ Using the Novu API and admin panel you can easily add real-time notification cen
 <div align="center">
 <img width="762" alt="notification-center-912bb96e009fb3a69bafec23bcde00b0" src="https://github.com/iampearceman/Design-assets/blob/main/Untitled%20design%20(8).gif?raw=true">
 
-  Read more about how to add a notification center to your app with the Novu API [here](https://docs.novu.co/notification-center/introduction)
+  Read more about how to add a notification center to your app with the Novu API [here](https://docs.novu.co/notification-center/introduction?utm_campaign=inapp-cli-readme)
 
 </div>
 
@@ -140,7 +140,7 @@ Novu provides a single API to manage providers across multiple channels with a s
 
 #### 📱 In-App
 
-- [x] [Novu](https://docs.novu.co/notification-center/introduction)
+- [x] [Novu](https://docs.novu.co/notification-center/introduction?utm_campaign=inapp-cli-readme)
 - [ ] MagicBell
 
 #### Other (Coming Soon...)

diff --git a/packages/node/README.md b/packages/node/README.md
@@ -126,7 +126,7 @@ Novu provides a single API to manage providers across multiple channels with a s
 
 #### 📱 In-App
 
-- [x] [Novu](https://docs.novu.co/notification-center/introduction)
+- [x] [Novu](https://docs.novu.co/notification-center/introduction?utm_campaign=node-sdk-readme)
 - [ ] MagicBell
 
 #### Other (Coming Soon...)

diff --git a/...ages/notification-center-angular/projects/notification-center-angular/README.md b/...ages/notification-center-angular/projects/notification-center-angular/README.md
@@ -16,7 +16,7 @@ This library contains a wrapper for the Novu Notification Center web component,
 
 ## 📖 Client Installation
 
-For our client installation guide, visit our [Angular Client docs](https://docs.novu.co/notification-center/client/angular).
+For our client installation guide, visit our [Angular Client docs](https://docs.novu.co/notification-center/client/angular?utm_campaign=github-notificationcenter-angular-readme).
 
 ## 🏃‍♂️ Quickstart
 

diff --git a/packages/stateless/README.md b/packages/stateless/README.md
@@ -99,7 +99,7 @@ Novu provides a single API to manage providers across multiple channels with a s
 
 #### 📱 In-App
 
-- [x] [Novu](https://docs.novu.co/notification-center/introduction)
+- [x] [Novu](https://docs.novu.co/notification-center/introduction?utm_source=github-stateless-readme)
 - [ ] MagicBell
 
 #### Other (Coming Soon...)