Skip to content

Commit baf41c0

Browse files
Update content on environment page (#915)
* Update content on environment page * Update content/docs/platform/concepts/environments.mdx Co-authored-by: Pawan Jain <[email protected]> * Update content base on Pawan's feedback --------- Co-authored-by: Pawan Jain <[email protected]>
1 parent eaa670f commit baf41c0

File tree

5 files changed

+42
-26
lines changed

5 files changed

+42
-26
lines changed

content/docs/platform/concepts/environments.mdx

Lines changed: 42 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,55 @@ description: 'Understanding and managing environments in Novu'
44
icon: 'GitFork'
55
---
66

7-
Novu uses environments to separate your development and production workflows. When you create an account, you'll get two default environments: `Development` and `Production`.
7+
Novu uses environments to separate your development and production workflows. When you create an account, you'll get two default environments: **Development** and **Production**.
88

9-
## Development Environment
9+
## Development environment
1010

11-
Use the development environment to test new notification workflows, validate changes before deploying to production, and experiment with different configurations.
11+
Use the development environment to build and test new workflows, layouts, translations, and experiment with different configurations before publishing to other environments.
1212

13-
## Production Environment
13+
## Production environment
1414

15-
The production environment is your live environment where notifications are sent to real users. Use the production environment for production use cases, and other environments for non-production use cases.
15+
The Production environment is your live environment, sending notifications to real users. To ensure stability and prevent unintended changes, this environment is view-only for workflows, layouts, and translations.
16+
17+
Changes are not made here directly but are pushed from the non production environment via the publishing process.
1618

1719
## Custom Environments
1820

19-
<Callout type="info">Custom environments are available in Team and Enterprise plans.</Callout>
21+
<Callout type="info">Custom environments are available in <a href="https://novu.co/pricing" target="_blank" rel="noopener noreferrer">Team and Enterprise plans</a>.</Callout>
2022

2123
Create custom environments to match your development workflow:
2224

2325
1. Go to the [Environments page](https://dashboard.novu.co/environments) in Novu dashboard
24-
2. Click on the `Create environment` button on the top right.
25-
3. A popup will appear. Enter names like `Staging` or `QA`.
26+
2. Click on the **Create environment** button on the top right.
27+
3. A menu will appear. Enter your preferred environment name.
2628
4. Assign unique colors to easily distinguish between environments.
27-
5. Click on `Create environment` button on the bottom right.
29+
![Publish changes](/images/developer-tools/create-environment.png)
30+
5. Click on **Create environment** button on the bottom right.
2831
6. New environment will be created and will be available in the environments list.
2932

30-
## What's Unique to Each Environment?
33+
## What's unique to each environment?
34+
35+
Each environment has a mix of isolated resources and assets that can be published from Development.
36+
37+
### Environment specific resources
3138

32-
Each environment maintains its own separate:
39+
These resources are completely separate and unique to each environment. Data in one environment has no connection to data in another. They are:
3340

3441
- Subscribers
3542
- Topics
36-
- Workflows
37-
- Webhooks
38-
- Integrations
43+
- Integrations (Provider credentials)
3944
- API keys (application identifier and secret key)
4045
- Activity feed
46+
- Webhooks
47+
48+
### Publishable assets
4149

42-
## Environment Credentials
50+
These assets are managed centrally in the Development environment and then published to other environments.
51+
- Workflows
52+
- Layouts
53+
- Translations
54+
55+
### Environment Credentials
4356

4457
Each environment has two unique identifiers:
4558

@@ -57,18 +70,21 @@ Each environment has two unique identifiers:
5770

5871
**Best Practice**: Configure these credentials in your application based on the active environment, similar to how you manage other service credentials.
5972

60-
## Promoting workflows between environments
73+
## Publishing changes to other environments
74+
75+
Novu provides a publish mechanism that allows you to promote changes from your dvelopment environment to production or other custom environments. This process ensures that all changes are deliberate, reviewed, and deployed in a controlled manner.
6176

62-
One workflow can be synced to another environment using the `Sync Workflow` option in workflow actions. While syncing, Novu will give option to which environment to sync the workflow to. If workflow with same identifier is already present in the destination environment, it will be overwritten with the source workflow.
77+
The publishing process bundles all modifications made to workflows, layouts, and translations since the last publish event.
6378

64-
Steps:
79+
### How to publish changes
6580

66-
1. Go to the [Workflows page](https://dashboard.novu.co/workflows) in Novu dashboard
67-
2. Click on the three dot menu in the workflow row
68-
3. If you have more than two environments, hover over the `Sync Workflow` option to see the destination environment, then click it.
69-
4. If you have only two environments, Click on the `Sync to <Environment Name>` option. Here `Environment Name` is the name of another environment.
70-
5. The workflow will be synced to the destination environment.
81+
After making modifications in your Development environment in the [Novu dashboard](https://dashboard.novu.co), you can promote them to another environment by following these steps:
7182

72-
<Callout type="info">
73-
Currently, a single workflow can be synced to another environment.
74-
</Callout>
83+
1. Ensure you are in the Development environment. All changes must originate from here.
84+
2. Click the **Publish changes** button in the top right of the screen.
85+
![Publish changes](/images/developer-tools/publish-changes.png)
86+
3. A list of available environments will appear. Select the environment you want to publish to.
87+
![Publish changes](/images/developer-tools/list-of-environment.png)
88+
4. A menu will open showing all the availabl workflows. Select the checkboxes next to the workflows you want to publish.
89+
![Publish changes](/images/developer-tools/publish-changes-modal.png)
90+
5. Click the publish button to publish the selected workflows to the selected environment.
496 KB
Loading
873 KB
Loading
1.08 MB
Loading
866 KB
Loading

0 commit comments

Comments
 (0)