There is an existing README.txt but there are the following issues:

- SETUP section should be titles INSTRUCTION. This section also contains a link, but it redirects to Simple FB Connect module's handbook. We need to verify if the same instructions apply for Social Auth Facebook, especially as the documentation states that this URL -> user/simple-fb-connect redirects user to Facebook, while the README's HOW IT WORKS section claims the URL is actually user/login/facebook.

Given we are following Social Auth Google's README and the Template as example, we need to add the REQUIREMENTS and MAINTAINERS sections.

Please fix these and provide patch.

CommentFileSizeAuthor
#11 interdiff-2934726-4-10.txt3.53 KBTanvish Jha
#10 2934726-10.patch1.59 KBTanvish Jha
#4 2934726-3.patch3.41 KBTanvish Jha
#5 2934726-4.patch3.41 KBTanvish Jha
#5 interdiff-2934726-3-4.txt1.48 KBTanvish Jha
#7 interdiff-2934771-2-6.txt805 bytesTanvish Jha

Comments

Kifah Meeran created an issue. See original summary.

MaskyS’s picture

MaskyS commented
Title: Update the README » Update the README for Social Auth Facebook

editing the title so it's not confusing on the parent issue.

Tanvish Jha’s picture

Tanvish Jha commented
Assigned: Unassigned » Tanvish Jha
Tanvish Jha’s picture

Tanvish Jha commented
Status: Active » Needs review
StatusFileSize
new 2934726-3.patch3.41 KB

I have made changes. Added the sections mentioned. I can verify that user/login/facebook works. Tested it myself.

Tanvish Jha’s picture

Tanvish Jha commented
StatusFileSize
new 2934726-4.patch3.41 KB
new interdiff-2934726-3-4.txt1.48 KB

Fixed some errors and trailing spaces errors.

MaskyS’s picture

MaskyS commented
Status: Needs review » Needs work 
  1. +++ b/README.txt
@@ -18,37 +21,51 @@ REQUIREMENTS
+INSTALLATION INSTRUCTIONS
+-------------------------

    Should be just INSTALLATION 

  2. +++ b/README.txt
@@ -18,37 +21,51 @@ REQUIREMENTS
+ * Google Summer of Code (https://www.drupal.org/google-summer-of-code-0)

    Let's add a description for GSoC? 

+++ b/README.txt
@@ -18,37 +21,51 @@ REQUIREMENTS
+   https://www.drupal.org/node/2642974

This link points to Simple FB Connect docs?

Tanvish Jha’s picture

Tanvish Jha commented
StatusFileSize
new interdiff-2934771-2-6.txt805 bytes
Tanvish Jha’s picture

Tanvish Jha commented
Tanvish Jha’s picture

Tanvish Jha commented
Tanvish Jha’s picture

Tanvish Jha commented
StatusFileSize
new 2934726-10.patch1.59 KB

This patch should work.

Tanvish Jha’s picture

Tanvish Jha commented
Status: Needs work » Needs review
StatusFileSize
new interdiff-2934726-4-10.txt3.53 KB
MaskyS’s picture

MaskyS commented
Status: Needs review » Needs work 
+++ b/README.txt
@@ -34,12 +33,27 @@ Drupal site. If we have an existing Drupal user with the same email address
 https://www.drupal.org/node/2642974

I think this link should be removed as it leads to the Documentation of FB Connect, which is different from that of Social Auth Facebook?

Tanvish Jha’s picture

Tanvish Jha commented

Yeah but the configuration part almost runs on the same lines which is why I kept it there.

Tanvish Jha’s picture

Tanvish Jha commented
Status: Needs work » Needs review

Thoughts? @Kifah and @gvso

MaskyS’s picture

MaskyS commented

My suggestion would be to create a documentation page stub for now and point the link to that. Then, once we're done with this issue series, we can work on that, or other students could finish the documentation guide. @gvso?

gvso’s picture

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

Just make the installation instructions similar to Social Auth Google, but remove the reference to the documentation in d.o.

  • gvso committed a543aa1 on 8.x-2.x 
    Issue #2934726 by Tanvish Jha, Kifah Meeran: Update the README for...
gvso’s picture

gvso
Primary language Spanish
commented
Status: Needs work » Fixed

Status: Fixed » Closed (fixed)

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