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
Comment #2
almaudoh CreditAttribution: almaudoh commentedComment #3
almaudoh CreditAttribution: almaudoh commentedComment #4
dpiIf 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):
Required files, required methods, covering basic annotation settings and what they mean.
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.
Comment #5
dpiIn related matters, I have plans to produce a blog post for announcing SMS framework 1.0, between now and final 1.0.
Comment #6
dpiA have created a number of developer doc pages for D8, anything missing?
Comment #7
almaudoh CreditAttribution: almaudoh commentedI'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.
Has this blog been published yet?
Comment #8
almaudoh CreditAttribution: almaudoh commentedCreated two new Documentation guides for D7 (https://www.drupal.org/docs/7/modules/sms-framework) and D8 (https://www.drupal.org/docs/8/modules/sms-framework)