[GSoC 2016: Social API] Week 11: Documentation

Submitted by gvso on Wed, 08/10/2016 - 08:43

We are getting closer to Google Summer of Code final evaluation. Students must start submitting their project in 5 days. During these months, I have been working on a project to harmonize social networking functionality in Drupal. So, it was time to start creating documentation about it. This week, I focus on documentation for site builders.

Achievements

This week, I have completed the Social API handbook which is available at https://www.drupal.org/node/2762333. This handbook includes general information about the project and its scope. Furthermore, I have added information and installation instructions for the different projects: Social API, Social Auth, Social Post, Social Widgets, Social Auth Google, and Social Post Twitter. It is also worth mentioning that all the project pages have overviews and references to documentation and other projects.

Social API Handbook

 

Moreover, thanks to a recommendation from Matthew Lechleider (@slurpee), I worked on documenting Social Auth Google and Social Post Twitter in Spanish. Thus, I created a blogpost on Social Auth Google and another on Social Post Twitter. In fact, I turn this blog into a multilingual site, so there is now a Spanish version of it.

Next week

Now, we have code committed and documentation for site builders written. Notwithstanding, the Social API project started as an idea for a framework in fact, the main components provide extensible functionality. Therefore, it is important to also document the process of creating new implementers such as Social Auth Google and Social Post Twitter. Thus, next week I will focus on creating documentation of how to create implementers for Social Auth and Social Post. 

As always, feel free to contact me if you have any question. You can also collaborate with the Social Initiative projects (social_apisocial_authsocial_post, and social_widgets). We also have our weekly meetings, so follow the Social Initiative and join us on Wednesdays.

Stay tuned for the next weekly summary!