Some content was cut from security-cron.txt and moved into security-cron-concept.txt.

There is no line break at 80 chars (yet)

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

dalin created an issue. See original summary.

dalin’s picture

Assigned: dalin » Unassigned
Status: Active » Needs review
FileSize
1.49 KB
stingrayfuse’s picture

Assigned: Unassigned » stingrayfuse
Issue tags: +SprintWeekend2016, +SprintWeekendBOS
stingrayfuse’s picture

Assigned: stingrayfuse » Unassigned
stingrayfuse’s picture

Assigned: Unassigned » stingrayfuse
Status: Needs review » Reviewed & tested by the community
stingrayfuse’s picture

Hi guys, I'm _brand_ new but this seemed to make sense to me (even as a non-developer) so I put it through. Hope that sits well with you all!

jhodgdon’s picture

Status: Reviewed & tested by the community » Needs work

Hm....

I don't think this is quite ready to add to the Guide:

a)

+++ b/source/en/security-cron-concept.txt
@@ -4,22 +4,13 @@
-//==== Prerequisite knowledge

For future reference... We actually do *not* want to completely remove empty sections from the templates, so this piece (and the similar one below) do not belong in this patch.

  1. +++ b/source/en/security-cron-concept.txt
    @@ -4,22 +4,13 @@
    +Cron is a task scheduler for periodic tasks. An action triggered by Cron is
    

    I don't think "Cron" should be capitalized at the end of this line.

    Actually it should be in italics as a new term, but only the one at the beginning of the line.

    _Cron_ is a task scheduler...

  2. +++ b/source/en/security-cron-concept.txt
    @@ -4,22 +4,13 @@
    +called a "cron job" or "cron maintenance task". Both Drupal core and many
    

    To me, the term "cron job" would refer to the whole cron process, not an individual action within the process.

    So maybe we could say "cron job" is the whole job, and "cron maintenance task" is one task within it?

  3. +++ b/source/en/security-cron-concept.txt
    @@ -4,22 +4,13 @@
    +contributed modules utilize Cron. For example: checking for module and theme
    +updates, indexing content for search, or cleaning up temporary files.
    

    This last sentence is not a sentence.

    maybe say:

    Examples of cron tasks include: ...

batigolix’s picture

Assigned: stingrayfuse » batigolix
Issue summary: View changes
Status: Needs work » Needs review
Issue tags: -SprintWeekend2016, -SprintWeekendBOS
FileSize
1.81 KB

Here is new version. Instead of addressing your feedback point by point, I reused the cron description we are using in the hook help of system.module (slightly adapted to be more like a user guide topic). It has been reviewed pretty well before (I hope) ;)

eojthebrave’s picture

Status: Needs review » Needs work

The text copied from hook_help() looks good to me. Good idea. I think we need to provide an attribution for this text though.

jhodgdon’s picture

Yeah... and the other problem is that technically, anything in hook_help() is in drupal Core and is therefore GPL, whereas our guide is CC-by-SA. So we cannot really copy that word for word. :(

batigolix’s picture

Status: Needs work » Needs review
FileSize
1.78 KB

I remember that now ;)

So here is a rewording without touching the main concepts:

Original from system_help():

In order for the site and its modules to continue to operate well, a set of routine administrative operations must run on a regular basis; these operations are known as cron tasks. On the Cron page, you can configure cron to run periodically as part of server responses by installing the Automated Cron module, or you can turn this off and trigger cron from an outside process on your web server. You can verify the status of cron tasks by visiting the Status report page. For more information, see the online documentation for configuring cron jobs.

User guide proposed text (see patch):

To ensure that your site site and its modules continues to function well, a group of administrative operations should run periodically. These operations are called _cron_ tasks. Examples of cron tasks are: checking for module and theme updates, indexing content for search, or cleaning up temporary files. The _Automated Cron_ module runs the cron tasks periodically as part of server responses. You can turn this off and trigger cron from a process outside of the server. You can check cron tasks' status in the status report.

batigolix’s picture

Fixing a couple of small errors

  • jhodgdon committed 1e4aa1e on 8.x-0.x
    Issue #2659172 by batigolix, dalin: Edits to security-cron-concept.txt
    
jhodgdon’s picture

Status: Needs review » Fixed

That looks good. I added batigolix to attributions as well as dalin. Reformatted slightly as well, see #2667978: Review/fix AsciiDoc formatting.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.