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

docs: Update .env.example for clearer inbound Postmark instructions #8235

Conversation

willkramer
Copy link
Contributor

Pull Request Template

Description

Updated the .env.example file to provide clearer instructions for setting up the Postmark inbound webhook. Many users, including myself, found the initial instructions ambiguous, leading to difficulties during setup. This change aims to simplify the process for future users by providing clearer instructions and examples.

Fixes #8234

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality not to work as expected)
  • This change requires a documentation update

How Has This Been Tested?

The updated instructions were tested during my personal setup of Chatwoot with Postmark. However, please note that these are documentation changes and do not directly affect the software's functionality.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented on my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (This may not be applicable since it's a documentation change)
  • New and existing unit tests pass locally with my changes (Again, this is more for code than documentation)
  • Any dependent changes have been merged and published in downstream modules (If there are dependent changes, you can check this)

@netlify
Copy link

netlify bot commented Oct 27, 2023

Deploy Preview for chatwoot-storybook canceled.

Name Link
🔨 Latest commit 607b072
🔍 Latest deploy log https://app.netlify.com/sites/chatwoot-storybook/deploys/653bc70da24feb0008a1a489

@willkramer willkramer changed the title Update .env.example for clearer inbound Postmark instructions docs: Update .env.example for clearer inbound Postmark instructions Oct 27, 2023
@sojan-official
Copy link
Member

@willkramer Thank you so much for your contribution. We truly appreciate your efforts. 🙏

Our team will prioritize reviewing and testing your changes according to our existing schedule and workload.
Should there be a need for any further actions or information from your side, we'll follow up here. 📨

Once again, we're grateful for your involvement and contribution to our community. 🚀🌟 🙌

@sojan-official sojan-official merged commit 394fece into chatwoot:develop Oct 27, 2023
8 of 9 checks passed
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update and Clarify .env.example Documentation for Inbound Postmark & Sendgrid Config
2 participants