Coming from #1111254: Document the Hostmaster API, I'd like help in documenting hook_post_hosting_TASK_TYPE_task. It looks like it's implemented pretty frequently, but most often in hosting_site.drush.inc.

The function signatures seem pretty consistent: HOOK_post_hosting_TASK_TYPE_task($task, $data). From the hook definition in drush_hosting_post_hosting_task:

I haven't yet found where the constants HOSTING_TASK and HOSTING_DRUSH_OUTPUT are set yet, though...

Comments

steven jones’s picture

steven jones commented
Category: support » bug

Lack of docs is a bug

steven jones’s picture

steven jones commented
Status: Active » Needs work

I've had a stab at adding some documentation for this in the dev-documentation branch.

steven jones’s picture

steven jones commented

hook_hosting_TASK_TYPE_task_rollback can be basically documented in the same way.

anarcat’s picture

anarcat commented
Category: bug » task

It is an issue, but i'd rather file those as tasks if you don't mind. i wouldn't block a release on docs, and we often go through the whole "list of bugs" before a release.

ergonlogic’s picture

ergonlogic
he/him
Primary language English
Location Montréal, Québec 🇨🇦
commented

In #1206414: Refactor to use proper Provision Drush hooks I quote Anarcat thusly:

The purpose of [hook_post_hosting_task()] is to collect stuff that was generated in the backend so that it propagates to the frontend.

It may be worth noting this in the docs, and pointing to Drush hooks (such as post_provision_verify() or post_provision_install()) as a more appropriate method to hook one's own code into the backend.

steven jones’s picture

steven jones commented
Status: Needs work » Fixed

I've beefed the documentation up a little in 6.x-2.x, we can raise further, specific issues in follow up issues.

Status: Fixed » Closed (fixed)

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

  • Commit 9d38126 on 6.x-2.x, dev-ssl-ip-allocation-refactor, dev-1205458-move_sites_out_of_platforms, 7.x-3.x, dev-588728-views-integration, dev-1403208-new_roles, dev-helmo-3.x by Steven Jones: 
    Issue #1113858 by Steven Jones: Beef up documentation of...

  • Commit 9d38126 on 6.x-2.x, dev-ssl-ip-allocation-refactor, dev-1205458-move_sites_out_of_platforms, 7.x-3.x, dev-588728-views-integration, dev-1403208-new_roles, dev-helmo-3.x by Steven Jones: 
    Issue #1113858 by Steven Jones: Beef up documentation of...