Update content on environment page #915
Conversation
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Caution Review failedThe pull request is closed. WalkthroughThe documentation for Novu environments was updated to provide clearer and more detailed explanations of environment usage, management, and the process for promoting changes. It introduces a new "Publish changes" workflow, replaces the older sync method, and includes updated instructions, reorganized sections, and additional screenshots. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Possibly related PRs
Suggested reviewers
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
content/docs/platform/concepts/environments.mdx (3)
23-25: Capitalize “Development environment” for consistencyEverywhere else in the doc you treat the default environments as proper nouns (“Development” / “Production”). Let’s keep that convention here as well.
-Changes are not made here directly but are pushed from the development environment via the publishing process. +Changes are not made here directly but are pushed from the Development environment via the publishing process.
83-83: Fix typo and apply consistent capitalization-Novu provides a publish mechanism that allows you to promote changes from your dvelopment environment to production or other custom environments. +Novu provides a publish mechanism that allows you to promote changes from your Development environment to the Production or other custom environments.
95-96: Correct spelling of “available”-4. A menu will open showing all the availabl workflows. Select the checkboxes next to the workflows you want to publish. +4. A menu will open showing all the available workflows. Select the checkboxes next to the workflows you want to publish.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
public/images/developer-tools/create-environment.pngis excluded by!**/*.pngpublic/images/developer-tools/list-of-environment.pngis excluded by!**/*.pngpublic/images/developer-tools/publish-changes-modal.pngis excluded by!**/*.pngpublic/images/developer-tools/publish-changes.pngis excluded by!**/*.png
📒 Files selected for processing (1)
content/docs/platform/concepts/environments.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/platform/concepts/environments.mdx
[grammar] ~83-~83: Ensure spelling is correct
Context: ...allows you to promote changes from your dvelopment environment to production or other cust...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~95-~95: Ensure spelling is correct
Context: ...ng) 4. A menu will open showing all the availabl workflows. Select the checkboxes next t...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - docs-novu
- GitHub Check: Header rules - docs-novu
- GitHub Check: Pages changed - docs-novu
- GitHub Check: Build and Lint
The environment page will live in the developer tools section of the docs in the new information architecture, which is why I created a new folder for it, so that I won't need to worry about that when it's moved. |
Co-authored-by: Pawan Jain <[email protected]>
|
|
||
| Changes are not made here directly but are pushed from the non production environment via the publishing process. | ||
|
|
||
| ## Custom Environments |
There was a problem hiding this comment.
@Aviatorscode2 - Please update this heading.
4 participants
Updated the content for the page
Summary by CodeRabbit