Suggested value for backup['cron']['notation'] in Automate documentation is not valid
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
See: https://docs.chef.io/delivery_server_backup.html#backup-cron
The documentation for configuring the backup cron includes an invalid cron notation value of backup['cron']['notation'] = "0 0 0/1 1/1 * ? * "
If a user tries to put that in their /etc/delivery/delivery.rb they will get the following error on Ubuntu systems:
May 10 18:58:01 HOSTNAME cron[1071]: Error: bad day-of-month; while reading /etc/cron.d/chef-automate-backup
May 10 18:58:01 HOSTNAME cron[1071]: (*system*chef-automate-backup) ERROR (Syntax error, this crontab file will be ignored)
A better value to show the user is backup['cron']['notation'] = "0 0 * * *" which is the default used in the crontab if it's not set in /etc/delivery/delivery.rb
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the backup-cron section at docs.chef.io/delivery_server_backup.html#backup-cron and compare the documented notation with the default crontab value described in the issue. Update the example so Ubuntu cron accepts it, then check the rendered documentation and the configuration snippet for consistency.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ubuntu
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100