Motivation

SMS Framework D7 and D8 versions are sorely lacking in documentation, and therefore is affecting adoption rate. The purpose of this meta-issue is to identify steps and follow-ups to address documentation gaps.

Resolution Plan

The plan would be to start with components, API's and site building / installation steps required to achieve the core functionalities. Thereafter more detailed information can be added.

All documentation will be placed on the Drupal.org Documentation Section for SMS Framework. A new section will need to be created and the existing documentation migrated.

Remaining Actions

  • Determine documentation section structure and topic areas
  • Build structure with stub documentation pages
  • Fill in with details over time

Child Issues

To keep track of issues that would require documentation, the Needs Documentation tag will be used to mark all issues (open, fixed or closed). This will allow the relevant information to be readily available when the details of the documentation pages are to be filled out.

All issues that would require documentation will be linked to this issue.

Comments

almaudoh created an issue. See original summary.

almaudoh’s picture

Issue summary: View changes
almaudoh’s picture

Issue summary: View changes
dpi’s picture

If we can identify some topics we need to cover? Perhaps this can even become a Drupalcon sprint task, since its quite an easy thing to do.

Things I would like to see docs on (d8):

  • Creating a gateway
    Required files, required methods, covering basic annotation settings and what they mean.
  • Explain what results and reports objects your gateway should produce.
  • ..?

I have already archived D6 docs under a D6 book.

And I have already created the doc page for basic usage for other modules using SMS send functions.

dpi’s picture

In related matters, I have plans to produce a blog post for announcing SMS framework 1.0, between now and final 1.0.

dpi’s picture

A have created a number of developer doc pages for D8, anything missing?

almaudoh’s picture

I've re-purposed the deprecated Drupal 6 documentation pages for the Drupal 7 release since all the instructions for D7 are basically same as D6.

I have plans to produce a blog post for announcing SMS framework

Has this blog been published yet?

almaudoh’s picture