The API changes for 2.x branch need to be documented.

The new guide is available at https://www.drupal.org/docs/8/modules/views-bulk-operations-vbo

TODO:

  1. Removed pass_view and pass_context annotations.
  2. Structure of action object $this->context.
  3. Document Drush command (maybe obsolete and the command --help alone will be enough?)

Comments

Graber created an issue. See original summary.

graber’s picture

graber commented

@joelpitet, I can write the page, but haven't found any information on how to do it, do I need to contact documentation maintainers for https://www.drupal.org/docs/8/modules?

graber’s picture

graber commented
Assigned: joelpittet » Unassigned
Priority: Normal » Minor

Lowering priority as it's better to focus on README.txt documentation along with hook_help() for now.

joelpittet’s picture

joelpittet
he/him
Primary language English
Location Vancouver
commented
Status: Active » Fixed

I've added a page here, I think you can add a page too.
https://www.drupal.org/docs/8/modules/views-bulk-operations-vbo

yes README.txt and hook_help() are also good.

  • Graber committed fb749da on 8.x-1.x 
    Issue #2884840: Improved module documentation; added hook_help...
graber’s picture

graber commented
Assigned: Unassigned » graber
Status: Fixed » Active

Great, thanks @joelpitet, somehow I couldn't add the page but I can edit the one created by you. Setting this to active untill the page content is finished.

  • Graber committed 5540ed9 on 8.x-1.x 
    Issue #2884840: Updated documentation.
graber’s picture

graber commented
Priority: Minor » Normal
Status: Active » Needs review

Guide is ready, reviews welcome.

graber’s picture

graber commented
Issue summary: View changes
joelpittet’s picture

joelpittet
he/him
Primary language English
Location Vancouver
commented

This is looking great, I'm glad Actions are annotations. On the getting started where it says [Annotation] in the code block, that is where an annotation goes right? If so it may be better to put the actual annotation example in there?

graber’s picture

graber commented

Good point @joelpitet, it'll be easier for developers to just copy a block of code including example annotation and alter it to their needs.

graber’s picture

graber commented
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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

graber’s picture

graber commented
Issue summary: View changes
Status: Closed (fixed) » Needs work

  • Graber committed 4cd0d5c on 8.x-1.x 
    Issue #2884840: Updated API documentation.
graber’s picture

graber commented
Status: Needs work » Needs review

Updated, hope everything is understandable.

graber’s picture

graber commented
Assigned: graber » Unassigned
graber’s picture

graber commented
Version: 8.x-1.x-dev » 8.x-2.x-dev
Issue summary: View changes
Status: Needs review » Needs work
graber’s picture

graber commented
Issue summary: View changes
graber’s picture

graber commented
Status: Needs work » Fixed

Status: Fixed » Closed (fixed)

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