Last week a number of community members worked on a digital sprint to improve the Developer Guide. The sprint was organised by CiviCooP (https://civicoop.org).
The sprint started with Michael O'Toole (aka mikeymjco) telling the rest about the documentation structure on GitLab, and straight after Alain Benbassat (aka alain.benbassat) demonstrating the usage of H5P interactive training elements (see https://h5p.org/) and Lumi (see https://next.lumi.education/) as a tool to create these elements on a desktop/laptop. The other participants immediately liked the tool and material and decided to have a play to see if we could see potential benefits.
After some initial play and discussion we did the following stuff during the sprint, some of it with H5P:
- Alain added an interactive example to the API4 section: https://docs.civicrm.org/dev/en/latest/api/v4/usage/#result
- Erik Hommel (aka ehommel) updated some text and added some interactive quiz elements to the extension/civix section: https://docs.civicrm.org/dev/en/latest/extensions/civix/#generate-module
- Jaap Jansma (aka jaapjansma) added a step by step guide on creating a cached config container: https://docs.civicrm.org/dev/en/latest/step-by-step/create-cached-config-container/ and one on creating an entity: https://docs.civicrm.org/dev/en/latest/step-by-step/create-entity/
- Tim Otten (aka totten) updated sections of the Developer Guide on REST and AuthX
At the moment the interactive elements of the Developer Guide are hosted at https://learn.civi.be but mikeymjco is working on some more "official" hosting solutions and some additional theming.
There will be ongoing work on adding interactive elements to the Developer Guide. If you want to join in, take part or ask questions please contact us at the Documentation channel on Mattermost: https://chat.civicrm.org/civicrm/channels/documentation
Thanks to everyone who took part in the sprint, reviewed progress, took part in discussions or gave moral support! Every contribution is highly appreciated and important.