Skip to content

Commit

Permalink
fix: restructure deploy section
Browse files Browse the repository at this point in the history
  • Loading branch information
scopsy committed Jul 14, 2024
1 parent 26578c1 commit 902353e
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 60 deletions.
39 changes: 0 additions & 39 deletions deployment/production.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,6 @@
title: "Going to Production"
---

Novu operates in a multi environment setup, with the currently available environments:

- **Local Studio** - Running against your local machine, this is where you can create, edit, and preview workflows.
- **Development** - Acts as a Staging environment, where your non-technical peers can view and modify controls.
- **Production** - For triggering workflows to your customers.

## Sync changes to Novu Cloud

Novu Framework operates in a GitOps model. This means that the source of truth for your workflows and configurations are located in your Git as Code.

The general workflow for pushing changes to Novu Cloud is as follows:

- Create a feature branch
- Develop workflows locally in your bridge application
- Sync changes to the Development environment to test e2e
- Merge the feature branch to your `dev` branch
- This will trigger a CI/CD pipeline that will deploy the changes to the Development environment
- Test the changes in the Development environment
- Merge the `dev` branch to the `main` branch
- This will trigger a CI/CD pipeline that will deploy the changes to the Production environment

## Networking

Novu Cloud workers will need to be able to communicate with your [Bridge Endpoint](/concepts/endpoint). You will need to ensure that your firewall rules allow traffic from the internet.
Expand Down Expand Up @@ -54,21 +33,3 @@ Schemes start with `v`, followed by an integer. Currently, the only valid live s
{/* todo add an example of the x-novu-signature header here */}

Handling the signature verification is done by the Novu Framework, so you don't need to perform any action.

## CI/CD Integrations

Novu currently supports the following CI integrations:

- **GitHub Actions** - [Direct Integration](/deployment/actions)
- **GitLab CI** - Using our [CLI command](/deployment/cli)
- **Jenkins** - Using our [CLI command](/deployment/cli)
- **CircleCI** - Using our [CLI command](/deployment/cli)
- **Bitbucket Pipelines** - Using our [CLI command](/deployment/cli)
- **Azure DevOps** - Using our [CLI command](/deployment/cli)
- **Travis CI** - Using our [CLI command](/deployment/cli)
- **Other** - For any other CI/CD tool, you can use our [CLI command](/deployment/cli)

<Info>
Direct integration with other CI/CD tools is on our roadmap. If you would like
to see a specific CI/CD tool integrated, please reach out to us.
</Info>
43 changes: 43 additions & 0 deletions deployment/syncing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: "Syncing your local changes to the Novu Cloud Dashboard"
sidebarTitle: "Overview"
---

Novu operates in a multi environment setup, with the currently available environments:

- **Local Studio** - Running against your local machine, this is where you can create, edit, and preview workflows.
- **Development** - Acts as a Staging environment, where your non-technical peers can view and modify controls.
- **Production** - For triggering workflows to your customers.

## Sync changes to Novu Cloud

Novu Framework operates in a GitOps model. This means that the source of truth for your workflows and configurations are located in your Git as Code.

The general workflow for pushing changes to Novu Cloud is as follows:

- Create a feature branch
- Develop workflows locally in your bridge application
- Sync changes to the Development environment to test e2e
- Merge the feature branch to your `dev` branch
- This will trigger a CI/CD pipeline that will deploy the changes to the Development environment
- Test the changes in the Development environment
- Merge the `dev` branch to the `main` branch
- This will trigger a CI/CD pipeline that will deploy the changes to the Production environment

## CI/CD Integrations

Novu currently supports the following CI integrations:

- **GitHub Actions** - [Direct Integration](/deployment/actions)
- **GitLab CI** - Using our [CLI command](/deployment/cli)
- **Jenkins** - Using our [CLI command](/deployment/cli)
- **CircleCI** - Using our [CLI command](/deployment/cli)
- **Bitbucket Pipelines** - Using our [CLI command](/deployment/cli)
- **Azure DevOps** - Using our [CLI command](/deployment/cli)
- **Travis CI** - Using our [CLI command](/deployment/cli)
- **Other** - For any other CI/CD tool, you can use our [CLI command](/deployment/cli)

<Info>
Direct integration with other CI/CD tools is on our roadmap. If you would like
to see a specific CI/CD tool integrated, please reach out to us.
</Info>
29 changes: 8 additions & 21 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
"pages": ["architecture/introduction", "architecture/diagrams"]
},
{
"group": "Building Workflows",
"group": "Build Workflows",
"pages": [
"workflow/introduction",
"workflow/studio",
Expand Down Expand Up @@ -142,8 +142,13 @@
]
},
{
"group": "Deployment",
"pages": ["deployment/production", "deployment/cli", "deployment/actions"]
"group": "Deploy",
"pages": [
"deployment/syncing",
"deployment/production", {
"group": "Platforms",
"pages": ["deployment/cli", "deployment/actions"]
}]
},

{
Expand All @@ -168,24 +173,6 @@
]
},
{
"group": "How To",
"pages": [
"how-to/introduction",
{
"group": "Workflow Examples",
"pages": [
"how-to/otp",
"how-to/password-reset",
"how-to/recent-login",
"how-to/invoice-receipt",
"how-to/shipping-confirmation",
"how-to/feedback-reviews"
]
}
]
},
{
"group": "SDKs & Client Libraries",
"group": "Framework Typescript SDK",
"pages": [
"sdks/framework/typescript/overview",
Expand Down

0 comments on commit 902353e

Please sign in to comment.