Make WP-Cron and Cavalcade docs more visible

Question

Make WP-Cron and Cavalcade docs more visible

Opened this issue 3 years ago · 8 comments

The documentation at https://docs.altis-dxp.com/cloud/scheduled-tasks/ is not easy to find due its naming, title and keyword content.

Searches for cron and cavalcade rank other pages more highly.

Acceptance criteria:

Rename docs page to "Cron Tasks"
Page ranks more highly in searches for "cron" and "cavalcade"

Original issue:

There's currently no information about how WP-Cron events are run on Altis Cloud. This is valuable information because the Cavalcade runner is an important part of the reliability, scaleability, and performance of cron events on sites.

Example documentation from VIP: https://docs.wpvip.com/technical-references/tools-for-site-management/cron-control/

Answer 1 · 2021-10-28T11:19:50.000Z

Might need a better page name / title, is this what you're after?

https://docs.altis-dxp.com/cloud/scheduled-tasks/

Answer 2 · 2021-10-28T12:18:19.000Z

Thanks, yes I think it does need a better name, it doesn't show up in a search for "cron" and it shows up low down the results in a search for "cavalcade".

Answer 3 · 2021-10-28T13:14:41.000Z

I'll update the title of this issue and extend the description with acceptance criteria based on this thread.

Answer 4 · 2021-10-29T11:07:44.000Z

I'd like to keep the title mostly as-is (as it's easier to understand for people less familiar with WP), but we can change it to "Scheduled Tasks (Cron)" or something, and increase the number of times we reference it?

Answer 5 · 2021-10-29T11:50:52.000Z

The search is a bit garbage for certain things anyway so I was wondering about supporting keywords in the YAML frontmatter and weighting those more heavily https://github.com/humanmade/altis-dev-docs-site/issues/94

Would still be useful when we switch to ES, I also need to try out the algolia search.

Answer 6 · 2021-10-29T13:29:06.000Z

I'd like to keep the title mostly as-is (as it's easier to understand for people less familiar with WP)

I'm not sure on that, scheduled tasks is very WordPressy language too, cron would be familiar to more developers I'd have thought.

Answer 7 · 2021-10-29T13:46:19.000Z

scheduled tasks is very WordPressy language too

I disagree, it's at the same level as cron from what I've seen.

Laravel calls it task scheduling, Symfony calls it cron jobs which it then defines as "Cron jobs allow you to run scheduled tasks", Drupal calls it cron automated tasks.

Answer 8 · 2021-10-29T14:27:40.000Z

Also...

I agree 'scheduling tasks/jobs' is good terminology, but sprinkling some references to cron, "chron" (because mistakes) and "wp cron" would help discoverability for as range of people.