We have a nice D8 landing page on api.drupal.org:
https://api.drupal.org/api/drupal/8

This is generated by a documentation block in file core/modules/system/core.api.php (at the top with @mainpage in it).

It needs a couple of links added to it, for the Batch API topic (machine name "batch") and Queue API (machine name "queue"). It should be I hope fairly obvious how to do this, similar to the other links that are already tehre, and I think these should go into the "Additional topics" section near the bottom of this page.

Should be a good Novice project?

CommentFileSizeAuthor
#5 add-link-to-queue-and-batch-apis-2265851-5.patch498 bytesmrjmd
#2 add-link-to-queue-and-batch-apis-2265851-2.patch1.36 KBmrjmd
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

mrjmd’s picture

mrjmd CreditAttribution: mrjmd commented
Assigned: Unassigned » mrjmd

Going to try my hand at this.

mrjmd’s picture

mrjmd CreditAttribution: mrjmd commented
Assigned: mrjmd » Unassigned
Status: Active » Needs review
FileSize
add-link-to-queue-and-batch-apis-2265851-2.patch1.36 KB

Here's my attempt.

Status: Needs review » Needs work

The last submitted patch, 2: add-link-to-queue-and-batch-apis-2265851-2.patch, failed testing.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

I'm not sure about the "invalid patch format" error on your patch test, but... There is another issue. The patch should only have these lines in it:

+ * - @link batch Batch API @endlink
+ * - @link queue Queue API @endlink

The batch and queue topics have already been written and already exist, so you do not need to add @defgroups for them. We just need the links added.

Thanks!

mrjmd’s picture

mrjmd CreditAttribution: mrjmd commented
Status: Needs work » Needs review
FileSize
add-link-to-queue-and-batch-apis-2265851-5.patch498 bytes

Thanks for the feedback... I just jumped into this so I was partially guessing how this worked. Here's another attempt.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Reviewed & tested by the community

Thanks! That's what we need.

  • Commit fbe1786 on 8.x by jhodgdon: 
    Issue #2265851 by mrjmd: Add links to Batch and Queue API to api landing...
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Reviewed & tested by the community » Fixed

Thanks again! Committed to 8.x.

Status: Fixed » Closed (fixed)

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