This project currently has no README. Please find all the relevant information listed on the project page, and create a README that has them. Remember to follow the the README Template.

CommentFileSizeAuthor
#35 readme-2934835-35.patch3.18 KBmashir
#32 intediff-2934835-30-32.txt613 bytesmashir
#32 readme-2934835-32.patch3.19 KBmashir
#30 intediff-2934835-29-30.txt3.78 KBmashir
#30 readme-2934835-30.patch3.19 KBmashir
#29 interdiff_26-19.txt788 bytesdhruveshdtripathi
#29 readme-2934835-29.patch3.22 KBdhruveshdtripathi
#26 readme-2934835-26.patch3.19 KBmashir
#24 readme-2934835-24.patch3.21 KBmashir
#24 interdiff-2934835-23-24.txt1.77 KBmashir
#23 2934835-23.patch3.24 KBmohit1604
#22 2934835-22.patch3.23 KBmohit1604
#21 implementers-list.png82.51 KBmashir
#19 readme-2934835-19.patch3.15 KBmashir
#19 interdiff-2934835-16-19.txt1.92 KBmashir
#16 readme-2934835-16.patch3.16 KBmashir
#12 after-patch.png4.38 KBAkanksha92
#10 readme-2934835-10.patch3.33 KBmashir
#8 readme-2934835-8.patch3.39 KBmashir
#6 creating_readme_file-2934835-6.patch0 bytesAkanksha92
#4 README.txt3.58 KBmashir

Comments

Kifah Meeran created an issue. See original summary.

MaskyS’s picture

MaskyS commented
Parent issue: » #2934841: Add and Update README's for the various Social Projects.
mashir’s picture

mashir commented
Assigned: Unassigned » mashir

Working on this.

mashir’s picture

mashir commented
Status: Active » Needs review
StatusFileSize
new README.txt3.58 KB

Please check the README.txt file.

MaskyS’s picture

MaskyS commented
Status: Needs review » Needs work

Hello, thanks for the README! It looks great! Just a few minor changes and we'll be ready to go.

  1.  * Install the The League OAuth2 client library by: composer require league/oauth2-client

    Let's put the command on the new line. 

  2.    This is the full list of available modules:
 
    - Social Post Twitter: Implementer for Twitter 
      (https://www.drupal.org/project/social_post_twitter)
 
    - Social Post Facebook: Implementer For Facebook
      (https://www.drupal.org/project/social_post_facebook)
 
    - Social Post Slack: Implementer For Slack 
      (https://www.drupal.org/project/social_post_slack)
 
    - Social Post Linkedin: Implementer For Linkedin 
      (https://www.drupal.org/project/social_post_linkedin)

    This list will inevitably grow, so let's reword this to "Visit {social API Drupal project page link} to find all the available implementers." 

  3.    source organization mentors such as us (Drupal!). Visit: https://summerofcode.withgoogle.com/

    We can shorten this link to g.co/gsoc 

  4.    kinds of contributions that make open source software development possible. Visit: https://codein.withgoogle.com/

    we can shorten this link to g.co/gci

Also, there are a lot of 80 col violations. Please find them with drupalcs and fix them. (Please see the coding standards.)
Finally, you need to provide a patch that will add the README, not the README itself.

Akanksha92’s picture

Akanksha92 commented
Status: Needs work » Needs review
StatusFileSize
new creating_readme_file-2934835-6.patch0 bytes

Created the patch for README including the few minor changes mentioned above. Followed https://www.drupal.org/docs/develop/documenting-your-project/readme-temp... for the README file. Please review.

mashir’s picture

mashir commented
Status: Needs review » Needs work

@Akanksha92 - When a task is assigned to someone, it does not make sense taking it over and also the submitted patch is a blank patch.

mashir’s picture

mashir commented
Status: Needs work » Needs review
StatusFileSize
new readme-2934835-8.patch3.39 KB

As per your suggestion I have attached the patch for README.txt with all the above changes.

MaskyS’s picture

MaskyS commented
Status: Needs review » Needs work

Thanks! We have a small problem:

+++ b/README.txt
@@ -0,0 +1,103 @@
+Social Post is part of the Social API. It provides a common interface for ¶
...
+This module defines a path /admin/config/social-api/social-post which displays ¶
+a table of implementers (modules to autopost to social network services ¶
...
+This module does not restrict the way an implementer module provides its ¶
...
+ * Download and install social_api module ¶
...
+ * Install the The League OAuth2 client library by: ¶
...
+	
...
+     ¶
+     Users in roles with the "Delete Social Post user accounts" permission ¶
...
+ ¶
...
+     ¶
...
+     Users in roles with the "View Social Post user entity lists" permission ¶
...
+ ¶
+ * Goto: Configuration >> Social API settings >> Autoposting settings ¶
...
+ * Now you can install modules which are based on Social Post module. After ¶
...
+   module configuration table. ¶
+   ¶
+   Visit: https://www.drupal.org/project/social_api to find all the ¶
...
+   managed by open source organization mentors such as us (Drupal!). ¶
...
+   (ages 13-17) to the many kinds of contributions that make open source ¶

Trailing whitespaces.

mashir’s picture

mashir commented
Status: Needs work » Needs review
StatusFileSize
new readme-2934835-10.patch3.33 KB

@Kifah Meeran - Removed all the whitespace and attached the patch.

MaskyS’s picture

MaskyS commented
Status: Needs review » Reviewed & tested by the community

Looks good to me now.

Akanksha92’s picture

Akanksha92 commented
StatusFileSize
new after-patch.png4.38 KB

The patch now applies cleanly. No errors and warnings found. Screenshot attached

mashir’s picture

mashir commented
mashir’s picture

mashir commented
gvso’s picture

gvso
Primary language Spanish
commented
Status: Reviewed & tested by the community » Needs work 
  1. +++ b/README.txt
@@ -0,0 +1,103 @@
+a table of implementers (modules to autopost to social network services

    I'd like to come up with another term than "social network." We have to start showing that the modules are not only related to social networks. A term we have been using instead is "(external) provider" 

  2. +++ b/README.txt
@@ -0,0 +1,103 @@
+ * Download and install social_api module
+  (https://www.drupal.org/project/social_api)
+
+ * Install the The League OAuth2 client library by:
+  composer require league/oauth2-client
+
+ * Download social_post module in your modules folder and enable 'Social Post'
+  (https://www.drupal.org/project/social_post)
+
+ * Visit: https://www.drupal.org/node/2780659 for more information.

    Running composer require drupal/social_post:^2.0 is enough

mashir’s picture

mashir commented
Status: Needs work » Needs review
StatusFileSize
new readme-2934835-16.patch3.16 KB

Hi @gvso,

Modified the patch as per the above suggestions. Patch attached.

Thanks!

gvso’s picture

gvso
Primary language Spanish
commented
Status: Needs review » Needs work 
  1. +++ b/README.txt
@@ -0,0 +1,98 @@
+creating modules related to autoposting to social network services.
+

    This sentence is still using the term "social network" 

  2. +++ b/README.txt
@@ -0,0 +1,98 @@
+a table of implementers (modules to autopost (external) provider services
+on users' behalf).

    Double parenthesis here. It just looks bad. 

  3. +++ b/README.txt
@@ -0,0 +1,98 @@
+This module does not restrict the way an implementer module provides its
+functionality. This allows the implementers to adapt to the social network's

    Just "implementer" instead of "implementer module." Also, still using the term social network. 

  4. +++ b/README.txt
@@ -0,0 +1,98 @@
+ * Require module: Social API (https://www.drupal.org/project/social_api)
+ * Require library: The League OAuth2 client library

    It should be "Required" 

  5. +++ b/README.txt
@@ -0,0 +1,98 @@
+ * Install the module from admin module page (/admin/modules) or using
+  drush command.

    Provide drush command 

  6. +++ b/README.txt
@@ -0,0 +1,98 @@
+ * Now you can install modules which are based on Social Post module. After
+  installing any of the implementer, it will display into the Social Post
+  module configuration table.

    Maybe "Now you can install modules which are based on Social Post. After
    installing implementers, they will be displayed in the Social Post implementer list."

Thanks!

mashir’s picture

mashir commented

Thanks @gvso for your valuable feedback. I am updating the patch and provide your the latest one soon.

mashir’s picture

mashir commented
Status: Needs work » Needs review
StatusFileSize
new interdiff-2934835-16-19.txt1.92 KB
new readme-2934835-19.patch3.15 KB

Hi @gvso,

Patch has been updated as per your suggestions and attached.

MaskyS’s picture

MaskyS commented
Status: Needs review » Needs work
Issue tags: -gci2017, -gci17-18

Hello, thanks for the hard work. Great to see this issue almost fixed. Here are a few things I found:

  1. +++ b/README.txt
@@ -0,0 +1,98 @@
+ * To download the module with all dependency run the below command:

    with all the dependencies,* 

  2. +++ b/README.txt
@@ -0,0 +1,98 @@
+  drush command.

    should be "using the drush command:" 

  3. +++ b/README.txt
@@ -0,0 +1,98 @@
+ * Now you can install modules which are based on Social Post. After installing

    can we replace the first line with "To post to different external provider services, you need to install the respective Social Post implementers"? That sounds better to me. 

  4. +++ b/README.txt
@@ -0,0 +1,98 @@
+  Visit: https://www.drupal.org/project/social_api to find all the

    Wrong link.

mashir’s picture

mashir commented
StatusFileSize
new implementers-list.png82.51 KB

Hi @MaskyS, @gvso,

Wrong link.

- I guess the link is correct. As you can see all the available implementers for this module from that link.

implementers-list

So do I need to remove that line or need to change the url? Please suggest.

mohit1604’s picture

mohit1604 commented
StatusFileSize
new 2934835-22.patch3.23 KB

Fixing points 1, 2 and 3 mentioned in #20.

mohit1604’s picture

mohit1604 commented
Status: Needs work » Needs review
StatusFileSize
new 2934835-23.patch3.24 KB

This should be fine, fixing points 1,2 and 3 as mentioned in #20.

mashir’s picture

mashir commented
StatusFileSize
new interdiff-2934835-23-24.txt1.77 KB
new readme-2934835-24.patch3.21 KB

Hi @MaskyS,

I have added first 3 points into the patch (#24) as you suggested in comment #20, and for point 4 I have added comment on #21 for your suggestion.

gvso’s picture

gvso
Primary language Spanish
commented
Status: Needs review » Needs work

Thanks everyone!

  1. +++ b/README.txt
@@ -0,0 +1,99 @@
+a table of implementers (modules to autopost external provider services
+on users' behalf).

    I feel like this sentence sounds weird. There should be a "to" after autopost and I think the word "services" is unnecessary. 

  2. +++ b/README.txt
@@ -0,0 +1,99 @@
+ * To post different external provider services, you need to install the

    "To post to external providers, you.." 

  3. +++ b/README.txt
@@ -0,0 +1,99 @@
+  Visit: https://www.drupal.org/project/social_api to find all the

    Change it to /social_post

mashir’s picture

mashir commented
Status: Needs work » Needs review
StatusFileSize
new readme-2934835-26.patch3.19 KB

Hi @gvso,

Thanks for your feedback. I have attached a new patch with all your suggested points in #25.

krina.addweb’s picture

krina.addweb commented

@Mashir, Thanks for the patch, But I need some more corrections in it. i.e.
> Change all URLs to Breadcrumb As per the ReadMe Standards described & shown in https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
> Check for the 'Text manually word-wrapped within around 80 cols.'

+
+This module defines a path /admin/config/social-api/social-post which displays
+a table of implementers (modules to autopost to external provider on users' behalf).

Can you please do the needful!.

gvso’s picture

gvso
Primary language Spanish
commented
Status: Needs review » Needs work

Thanks! We are almost there

+++ b/README.txt
@@ -0,0 +1,98 @@
+a table of implementers (modules to autopost to external provider on users' behalf).

It should be plural: "providers"

Also, follow @krina.addweb's feedback and remove all references to the term "social network"

dhruveshdtripathi’s picture

dhruveshdtripathi commented
Status: Needs work » Needs review
StatusFileSize
new readme-2934835-29.patch3.22 KB
new interdiff_26-19.txt788 bytes

Did changes mentioned in both #27 and #28.

mashir’s picture

mashir commented
StatusFileSize
new readme-2934835-30.patch3.19 KB
new intediff-2934835-29-30.txt3.78 KB

Hi @krina.addweb, both your suggested points are added in new patch [All the URL's into Breadcrumb and around 80 characters in each line].

It should be plural: "providers"

@gvso - I have changed it.

Patch (#30) has been attached.

ankitjain28may’s picture

ankitjain28may commented
Status: Needs review » Needs work

The patch in #29 is not fulfilling all the requirements.
The patch in #30 is almost as per the requirements except this-

+++ b/README.txt
@@ -0,0 +1,98 @@
+This allows the implementers to adapt to the social network's requirements they

Need to remove all reference to the term "social network" as per the comment #28

mashir’s picture

mashir commented
Status: Needs work » Needs review
StatusFileSize
new readme-2934835-32.patch3.19 KB
new intediff-2934835-30-32.txt613 bytes

Hi @ankitjain28may, Thanks for your feedback. The suggested changes has been implemented to the new patch (#32).

@gvso - Latest patch has been attached (#32).

ankitjain28may’s picture

ankitjain28may commented

Thanks @Mashir, Patch is applied cleanly and as per the requirement. Let @gvso review it too.

MaskyS’s picture

MaskyS commented
Status: Needs review » Needs work

Thanks everyone.

  1. +++ b/README.txt
@@ -0,0 +1,98 @@
+  the drush command.

    The "." should be replaced with ":" 

  2. +++ b/README.txt
@@ -0,0 +1,98 @@
+ * Goto: Configuration » Social API settings » Autoposting settings.

    Looks like we're missing a space here, should be "Go to". Also, can we remove the colon? 

  3. +++ b/README.txt
@@ -0,0 +1,98 @@
+ * To post to external providers, you need to install the respective Social Post

    I apologize, "their respective" would be more fitting here 

  4. +++ b/README.txt
@@ -0,0 +1,98 @@
+  Visit: https://www.drupal.org/project/social_post to find all the available

    Could we remove the colon? 

  5. +++ b/README.txt
@@ -0,0 +1,98 @@
+  Visit: g.co/gsoc for more information.
...
+  development possible. Visit: g.co/gci for more information.

    remove the colons here too?

Other than that this looks perfect to me. Thanks again!

mashir’s picture

mashir commented
Status: Needs work » Needs review
StatusFileSize
new readme-2934835-35.patch3.18 KB

Hi @MaskyS, All changes has been resolved in the attached patch (#35).

@gvso - I guess no need to change anything for now in README.txt. Please review once.

MaskyS’s picture

MaskyS commented
Status: Needs review » Needs work

@mashir See #34 No. 3

mashir’s picture

mashir commented
Status: Needs work » Needs review

@MaskyS - As i believe that the term "their" is meaningless. If you use "their" term than it indicates to whom, so I guess it will better to remove "the" and "their" from that line (what I did in patch #35). So the line will be simply:

To post to external providers, you need to install respective Social Post

But if you really want to add "their" then I will add it.

  • gvso committed 5467a04 on 8.x-2.x authored by Mashir 
    Issue #2934835 by Mashir, mohit1604, Akanksha92, dhruveshdtripathi,...
gvso’s picture

gvso
Primary language Spanish
commented
Status: Needs review » Fixed

I added "their" in that line.

Thanks everyone!

Status: Fixed » Closed (fixed)

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