Modules doesn't have a Help doc yet.
If possible do mention steps to use this module.

More to include:
* #2851986: Youtube Account not properly configured

CommentFileSizeAuthor
#20 interdiff-2846262-16-20.txt4.8 KByogeshmpawar
#20 2846262-20.patch4.26 KByogeshmpawar
#16 interdiff-2846262-13-16.txt4.22 KByogeshmpawar
#16 2846262-16.patch3.72 KByogeshmpawar
#13 implement_hook_help-2846262-13.patch2.78 KBswarad07
#11 implement_hook_help-2846262-11.patch2.77 KBdhruveshdtripathi
#3 2846262-implement-hook-help.patch2.14 KBswati.nuna

Comments

JayKandari created an issue. See original summary.

sneha_surve’s picture

sneha_surve commented
Assigned: Unassigned » sneha_surve
swati.nuna’s picture

swati.nuna commented
Version: » 8.x-1.x-dev
Status: Active » Needs review
StatusFileSize
new 2846262-implement-hook-help.patch2.14 KB

Hello,

Please verify attached patch file.
Here I have added hook_help() with steps to use a module.

jaykandari’s picture

jaykandari
Primary language Hindi
commented
Status: Needs review » Needs work

@swati.nuna : Pls do not pick an issue which is already assigned to some other user, they might be working on it. or you could ask the user if they are working on this issue and update issue meta accordingly.

Bonus, #3 is okay, if the assigned user could further add steps to configure Google Application & How values should be passed in Dtuber config form & in Google Console, this would be helpful. Thanks!

swati.nuna’s picture

swati.nuna commented

@JayKandari : Thanks, I will remember your comment.

jaykandari’s picture

jaykandari
Primary language Hindi
commented
Issue summary: View changes
swarad07’s picture

swarad07
Primary language English
Location Navi Mumbai, India
commented

Just checking if people in #2 are working on this? I don't see any comments from them.

jaykandari’s picture

jaykandari
Primary language Hindi
commented

@swarad07 : Its been quite a long time since #2. you could go ahead and assign it to yourself. Thanks !

sneha_surve’s picture

sneha_surve commented
Assigned: sneha_surve » Unassigned
dhruveshdtripathi’s picture

dhruveshdtripathi commented
Assigned: Unassigned » dhruveshdtripathi

Working on it to simplify help page according to standards.

dhruveshdtripathi’s picture

dhruveshdtripathi commented
Assigned: dhruveshdtripathi » Unassigned
Status: Needs work » Needs review
StatusFileSize
new implement_hook_help-2846262-11.patch2.77 KB

Implemented help hook with help page standards like it should have About and Uses. Added Installation guide from module page.

swarad07’s picture

swarad07
Primary language English
Location Navi Mumbai, India
commented
Status: Needs review » Needs work 
+++ b/dtuber.module
@@ -16,3 +18,39 @@ function dtuber_theme() {
+      $output .= '<p>' . t('aka "Drupal YouTuber" - Uploads Video to a YouTube Channel. Provides a new Field type, that can be attached to a Content-type.') . '</p>';

This should read Dtuber aka "Drupal Youtuber". Starting the line with aka is not making much sense.

swarad07’s picture

swarad07
Primary language English
Location Navi Mumbai, India
commented
Status: Needs work » Needs review
StatusFileSize
new implement_hook_help-2846262-13.patch2.78 KB

Correcting the typo.

sneha_surve’s picture

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

Patch works fine.
Hence changing the status to RTBC.

jaykandari’s picture

jaykandari
Primary language Hindi
commented
Status: Reviewed & tested by the community » Needs work

Appreciated #11 & #13.

Instead of just copying contents from project page. A detailed explanation about following would be of great help.

* How to Configure Google Console Application - A line about which options to select when creating an application (eg: Web Application/ Redirect uri etc).
* Can add a section relating to uploading video via the test upload form.
* A detailed information about creating a Google Applicaion, Providing credentials to Dtuber configuration and authorizing.

This documentation shall also be moved to project page. One can move ahead with the latest patch file.

Thanks !

yogeshmpawar’s picture

yogeshmpawar
He/Him/His
Primary language English
Location Pune(MH), INDIA 🇮🇳
commented
Status: Needs work » Needs review
StatusFileSize
new 2846262-16.patch3.72 KB
new interdiff-2846262-13-16.txt4.22 KB

@JayKandari - Here's the updated patch which fulfils your requirement in #15 & also added an interdiff.

jaykandari’s picture

jaykandari
Primary language Hindi
commented
Status: Needs review » Needs work

Thanks !!

Just some minor changes... 

+++ b/dtuber.module
@@ -16,3 +18,40 @@ function dtuber_theme() {
+      $output .= '<dd>' . t('2. Set Client ID, Client Secret ID in DTuber <a href="/admin/config/media/dtuber">configuration page</a> (/admin/config/media/dtuber) as mentioned in <a href="https://console.developers.google.com/apis/credentials">credentials</a>.' ) . '</dd>';
...
+      $output .= '<dd>' . t('Another way to test Video Uploads. Goto : <a href="/admin/config/media/dtuber/test">configuration page</a>. Fill in fields and submit form. <br/> Check your YouTube Channel for latest updated Video.') . '</dd>';

Using /admin/config/media/dtuber doesn't work in sites installed in subdirectory. For eg: if drupal is installed in http://localhost/drupal8, these links will point to https://localhost/admin/config/media/dtuber, which is invalid. 

+++ b/dtuber.module
@@ -16,3 +18,40 @@ function dtuber_theme() {
+      $output .= '<dd>' . t('1. Create an application at <a href="http://console.developers.google.com">http://console.developers.google.com</a> & <a href="https://console.developers.google.com/apis/library/youtube.googleapis.com/?id=125bab65-cfb6-4f25-9826-4dcc309bc508&project=forward-pad-135123">Enable YouTube Data API</a>.') . '</dd>';
...
+      $output .= '<dd>' . t('Another way to test Video Uploads. Goto : <a href="/admin/config/media/dtuber/test">configuration page</a>. Fill in fields and submit form. <br/> Check your YouTube Channel for latest updated Video.') . '</dd>';

Can we use Link module to generate Link?

Also, Pls not the related issue #2851986: Youtube Account not properly configured.

Thanks !!

yogeshmpawar’s picture

yogeshmpawar
He/Him/His
Primary language English
Location Pune(MH), INDIA 🇮🇳
commented
Assigned: Unassigned » yogeshmpawar
guptahemant’s picture

guptahemant commented

hi @jaykandari and @Yogesh Pawar regarding hook_help,Wouldn't it be better to add documentation in Readme.md file and call that directly in hook_help implementation like this:

      $output = '<pre>' . file_get_contents(drupal_get_path('module', 'dtuber') . '/README.md') . '</pre>';
      return $output;

This will allow consistent documentation in help as well as readme file.

yogeshmpawar’s picture

yogeshmpawar
He/Him/His
Primary language English
Location Pune(MH), INDIA 🇮🇳
commented
Assigned: yogeshmpawar » Unassigned
Status: Needs work » Needs review
StatusFileSize
new 2846262-20.patch4.26 KB
new interdiff-2846262-16-20.txt4.8 KB

@jaykandari - As per your comments in #17, below is the updated patch with an interdiff.

jaykandari’s picture

jaykandari
Primary language Hindi
commented
Status: Needs review » Fixed

@yogesh:
Looks good.
Added 

use Drupal\Core\Link;
use Drupal\Core\Url;

committed & pushed to 8.x-1.x.

Thank you everyone for contribution. :)

yogeshmpawar’s picture

yogeshmpawar
He/Him/His
Primary language English
Location Pune(MH), INDIA 🇮🇳
commented

Thanks @JayKandari for committing this issue, thanks for adding two "use statements". i missed it while creating patch.

Status: Fixed » Closed (fixed)

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