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: add snapshot_cron flag in README (English and zh-CN) #1729

Merged
merged 1 commit into from
Aug 27, 2023

Conversation

Niennienzz
Copy link
Contributor

  • Add docs for the snapshot_cron flag in README.md and README.zh-CN.md.
  • A few formatting minor changes in README.zh-CN.md.
  • There's one place Memcached is mis-spelled as Memcache. Fixed in all languages.

@Niennienzz Niennienzz self-assigned this Aug 23, 2023
@romange
Copy link
Collaborator

romange commented Aug 24, 2023

@Niennienzz there are some whitespace problems

@Niennienzz Niennienzz force-pushed the joezhou/doc-snapshot-cron branch 2 times, most recently from 4026ec5 to 903f654 Compare August 24, 2023 20:06
@Niennienzz
Copy link
Contributor Author

@Niennienzz there are some whitespace problems

Thank you @romange, fixed!

I think the only CI failing is because of timeout?

@@ -106,7 +106,8 @@ There are also some Dragonfly-specific arguments:
* `dbnum`: Maximum number of supported databases for `select`.
* `cache_mode`: See the [novel cache design](#novel-cache-design) section below.
* `hz`: Key expiry evaluation frequency (`default: 100`). Lower frequency uses less CPU when idle at the expense of a slower eviction rate.
* `save_schedule`: Glob spec for the UTC to save a snapshot in HH:MM (24h time) format (`default: ""`).
* `snapshot_cron`: Cron schedule expression for automatic backup snapshots using standard cron syntax with the granularity of minutes (`default: ""`).
Copy link
Collaborator

Choose a reason for hiding this comment

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

it's not straightforward so I think it's a great place to add some examples with the explanation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added examples, linked to our "Saving Backups" doc. 😃

@Niennienzz Niennienzz force-pushed the joezhou/doc-snapshot-cron branch 2 times, most recently from 9de7e55 to e625e1f Compare August 25, 2023 18:30
README.md Outdated
|---------------------------|------------------------------------------------|
| `* * * * *` | At every minute |
| `*/5 * * * *` | At every 5th minute |
| `*/30 * * * *` | At every 30th minute |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks, let's remove lines 116, 120, 117 :)

docs: fix whitespaces in kr

docs: snapshot_cron examples

docs: snapshot_cron less examples
@romange romange merged commit 343b3ef into main Aug 27, 2023
10 checks passed
@romange romange deleted the joezhou/doc-snapshot-cron branch August 27, 2023 17:19
kostasrim pushed a commit that referenced this pull request Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants