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: Improve cron tasks and fix link in documentation #2708

Merged
merged 6 commits into from
Aug 2, 2022
Merged

docs: Improve cron tasks and fix link in documentation #2708

merged 6 commits into from
Aug 2, 2022

Conversation

JiLleON
Copy link
Contributor

@JiLleON JiLleON commented Jul 31, 2022

Description

Everything that was mentioned in the issue and fixing the link to the actual

Fixes #2702

Type of change

  • Improvement (non-breaking change that does improve existing functionality)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (README.md or the documentation under docs/)
  • If necessary I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

adding an example with cron inside container to avoid possible errors

adding 'MAILTO=""' option to the cron tasks to prevent
cron from sending messages to email after completing tasks
@georglauterbach georglauterbach added kind/improvement Improve an existing feature, configuration file or the documentation area/documentation labels Jul 31, 2022
@georglauterbach georglauterbach added this to the v11.2.0 milestone Jul 31, 2022
docs/content/config/advanced/full-text-search.md Outdated Show resolved Hide resolved
docs/content/config/advanced/full-text-search.md Outdated Show resolved Hide resolved
docs/content/config/advanced/full-text-search.md Outdated Show resolved Hide resolved
docs/content/faq.md Outdated Show resolved Hide resolved
docs/content/config/environment.md Show resolved Hide resolved
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
polarathene
polarathene previously approved these changes Aug 1, 2022
Copy link
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

You might want to still confirm the request from @casperklein on the associated issue.

While I don't mind the MAILTO mention since the comment makes it clear what it prevents, some users may prefer to still be notified about failures, while ignoring successful tasks.

adding '> /dev/null' instead of 'MAILTO=""' that only
error messages come to the email 'postmaster@example.com'
casperklein
casperklein previously approved these changes Aug 1, 2022
@JiLleON JiLleON dismissed stale reviews from casperklein and polarathene via fd0a391 August 1, 2022 19:23
@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2022

Documentation preview for this PR is ready! 🎉

Built with commit: fbab83f

@@ -184,23 +184,25 @@ The following configuration works nicely:
# This assumes you're having `environment: ONE_DIR=1` in the env-mailserver,
# with a consolidated config in `/var/mail-state`
#
# '> /dev/null' to send error notifications from 'stderr' to 'postmaster@example.com'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's technically meant to omit stdout to avoid reports that are unnecessary, thus only stderr would trigger reports.

@polarathene polarathene merged commit e99bba2 into docker-mailserver:master Aug 2, 2022
@JiLleON JiLleON deleted the improve-documentation branch August 2, 2022 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation kind/improvement Improve an existing feature, configuration file or the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FR] improving documentation in cron tasks
4 participants