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

add documentation about the maintenance job(s) #906

Closed
wants to merge 1 commit into from
Closed

add documentation about the maintenance job(s) #906

wants to merge 1 commit into from

Conversation

tilsammans
Copy link
Contributor

See #861 for the actual change.

@tilsammans tilsammans self-assigned this Nov 14, 2017
@tilsammans tilsammans requested a review from aviav November 14, 2017 13:50
@coveralls
Copy link

coveralls commented Nov 14, 2017

Coverage Status

Coverage remained the same at 99.204% when pulling 149e64c on scrollytelling:doc-prune_auto_snapshots_jobs into 40cda2b on codevise:master.

@aviav
Copy link
Contributor

aviav commented Nov 14, 2017

I see the point of adding documentation for the task. I'd rather add it to the Troubleshooting section [1] of the Wiki, because needing the task is contingent on both a) an active user base and b) storage space running out, and this advice shoots trouble (see b)).

README.md up until now seems to me like a place for less situational info. People who manage to grow an active userbase for Pageflow will at some point notice the Troubleshooting section. I'd be surprised if this happens only after they hit a storage limit for their database.

In terms of content, I approve this. If you move it to the Wiki, maybe the reference to Whenever can be left out to leave this deployment choice completely open. This would resemble our practice of not mentioning specific optional deployment choices in the documentation to decrease the future amount of stale docs. Good job in any case!

[1] https://github.com/codevise/pageflow/wiki/Troubleshooting

@tilsammans
Copy link
Contributor Author

Totally fine with the Wiki; not on board with the Troubleshooting section. To me that reads more like, "I have this error message now what do I do?". So I added a new page: https://github.com/codevise/pageflow/wiki/Maintenance

@tilsammans tilsammans closed this Nov 14, 2017
@tilsammans tilsammans deleted the doc-prune_auto_snapshots_jobs branch November 14, 2017 19:53
@aviav
Copy link
Contributor

aviav commented Nov 15, 2017

Even better!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants