Details

    • Type: Sub-task Sub-task
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Deferred
    • Component/s: moodle.org/plugins
    • Labels:
      None
    • Rank:
      19768

      Description

      REGISTERING A NEW PLUGIN

      Is there a need for a Source control URL in the Plugin information section if a URL is provided for each version?

      There should a help button that informs uploaders of the expected structure of the zip, or at least refers them to such information. It's obviously a plugin directory, but there will need to be specific files that the Plugins system draws information from. Perhaps these can be specified. Also, in the current M&P there is a lot of inconsistency in provided zips. Some people don't have a folder containing their plugin code, others bury their code several folders deep. (Noted later) Perhaps the information shown when adding a version could be presented as help with the initial zip.

      Is it necessary to have a website link for each version? Perhaps this could become a change-log link. When adding later versions there is no website link.

      If I don't provide a Logo image, a broken image appears in the Plugins list.

      Errors appeared after saving the new plugin. Reported as HQ-24.

      AFTER REGISTERING

      The author's name should be more prominent. Perhaps we can add their photo and a link to their profile. We should look at ways of promoting authors here and perhaps giving an indication of the other contributions, experience, ratings, etc.

      What version do the traffic light indicators in the top-right of the page relate to? Or is this all versions.

      In terms of versions, how do I indicate which version of Moodle the version of my contribution relates to. How is this expressed to people who want to download my contribution. There should be a Moodle version identified with each version of the block uploaded. This could be gathered from $plugin->requires, or from a field indicated with the upload, perhaps we should have both and cross-check.

      For the Docs tab, is this intended to replace documentation in docs.moodle.org for the contribution? If so, not a bad idea, but how will automatic linking from configuration pages be affected? Perhaps we could continue to link to docs.moodle.com, or embed a page from there in the tab.

      When I click on the download tab, what version am I downloading? Is it the latest version? How do I know I'm getting the correct version for my Moodle version? Perhaps the tab name should say "Download latest version".

      On the Download tab, the "approved" and "available" terms are not highlighted. This is inconsistent with the other pages.

      Under Installation instructions on the download page, you should refer the downloader to the readme file or documentation for additional setup instructions. You could probably remove "Installation complete!". The word "their" is mispelt.

      EDITING A CONTRIBUTED PLUGIN / ADDING A VERSION

      Errors were reported with this. Recorded as HQ-26.

      It was good to see the instructions on file conventions here. Adding instructions about the folder structure of the zip would be good.

      Again, there should be a way of indicating what version of Moodle the new version of the plugin relates to.

      What does previous version mean? Some help icons should appear with the this setting.

      What about the other settings that appeared when adding the original version, such as repository links? I think there needs to be the same links here so that people can maintain multiple repository branches for different versions.

        Activity

        Hide
        Sam Hemelryk added a comment -

        Look at me!

        Show
        Sam Hemelryk added a comment - Look at me!
        Hide
        Michael de Raadt added a comment -

        "Here's looking at you, kid!"

        It was good to see some help strings.

        I noted that it was possible to modify the version name when editing a version, but this option was not available when uploading the first version.

        The Moodle version I chose when uploading the zip was not shown with the plugin version information. This still needs to be added.

        Even though I didn't add links to a website, alternate download or a repository, links for these were still shown in the version information.

        Show
        Michael de Raadt added a comment - "Here's looking at you, kid!" It was good to see some help strings. I noted that it was possible to modify the version name when editing a version, but this option was not available when uploading the first version. The Moodle version I chose when uploading the zip was not shown with the plugin version information. This still needs to be added. Even though I didn't add links to a website, alternate download or a repository, links for these were still shown in the version information.
        Hide
        Anthony Borrow added a comment -

        Just adding the contents of an email from Nick that I received for review later:

        -from Nick-
        In the meantime, I have some thoughts on statistics/analytics for contributed plugins. If you're working on a new database, perhaps they can be considered at the same time. Cheers Nick


        Add statistics/analytics for contrib plugins hosted externally, eg. on Github
        The move to hosting plugins on Github makes things easier for everyone concerned.
        However, one thing is lost along the way - the ability to see the most basic of statistics, eg. number of downloads (http://download.moodle.org/stats.php). I, and I suspect other creators of contributed plugins would like to see numbers of visits to the plugins-DB entry, number of downloads etc. - it could be a useful spur for fixing bugs/adding new features to contributed plugins!

        I have two proposals:

        1. Could the download.php script be modified (or a new track.php/ ext.php be created), that logs redirects to external downloads.
        Eg. /ext.php?plugin_id=1234&url=http://example.org/external/zip

        Some pseudo-code would look like:
        IF plugin_id is valid:
        INSERT in downloads_log (plugin_id, url ...)
        REDIRECT to url
        ENDIF;

        2. Could a new field-type be added to the Database module (would this necessitate a core modification?) - 'analytics-id'?
        This would accept a pattern /^([A-Z]

        {2,8}

        )(\d+)(\d+)?$/ eg. UA-123456-1.
        The id would be used to insert eg. a Google Analytics javascript in the page for that database entry (it could in time support other Analytics systems via the prefix).
        $prefix = $matches[1];
        $analytics_id= $matches[0];
        This way, everyone who has a plugin in the plugin DB can add their own tracking code, and see their own statistics. There may be other use-cases for this in the Database module.

        Note, this is inspired by Bitbucket.org, and that site demonstrates that a page can contain more than one Google Analytics tracking code.

        Note 2, I believe that Google Analytics has Javascript hooks to track clicks on links etc. I would propose that links to eg. documentation, bug tracker, discussion, download-1.9, download-2.0 be tracked.

        I suggest that both proposals could be implemented, 1 in the short-term, and 2 the one touching more code in the medium term, after feedback and planning.

        Show
        Anthony Borrow added a comment - Just adding the contents of an email from Nick that I received for review later: - from Nick - In the meantime, I have some thoughts on statistics/analytics for contributed plugins. If you're working on a new database, perhaps they can be considered at the same time. Cheers Nick – Add statistics/analytics for contrib plugins hosted externally, eg. on Github The move to hosting plugins on Github makes things easier for everyone concerned. However, one thing is lost along the way - the ability to see the most basic of statistics, eg. number of downloads ( http://download.moodle.org/stats.php ). I, and I suspect other creators of contributed plugins would like to see numbers of visits to the plugins-DB entry, number of downloads etc. - it could be a useful spur for fixing bugs/adding new features to contributed plugins! I have two proposals: 1. Could the download.php script be modified (or a new track.php/ ext.php be created), that logs redirects to external downloads. Eg. /ext.php?plugin_id=1234&url= http://example.org/external/zip Some pseudo-code would look like: IF plugin_id is valid: INSERT in downloads_log (plugin_id, url ...) REDIRECT to url ENDIF; 2. Could a new field-type be added to the Database module (would this necessitate a core modification?) - 'analytics-id'? This would accept a pattern /^( [A-Z] {2,8} ) (\d+)( \d+)?$/ eg. UA-123456-1. The id would be used to insert eg. a Google Analytics javascript in the page for that database entry (it could in time support other Analytics systems via the prefix). $prefix = $matches [1] ; $analytics_id= $matches [0] ; This way, everyone who has a plugin in the plugin DB can add their own tracking code, and see their own statistics. There may be other use-cases for this in the Database module. Note, this is inspired by Bitbucket.org, and that site demonstrates that a page can contain more than one Google Analytics tracking code. Note 2, I believe that Google Analytics has Javascript hooks to track clicks on links etc. I would propose that links to eg. documentation, bug tracker, discussion, download-1.9, download-2.0 be tracked. I suggest that both proposals could be implemented, 1 in the short-term, and 2 the one touching more code in the medium term, after feedback and planning.
        Hide
        Marina Glancy added a comment -

        This issue needs to be reviewed (a lot is done already) and converted to the smaller issues for particular required changes

        Show
        Marina Glancy added a comment - This issue needs to be reviewed (a lot is done already) and converted to the smaller issues for particular required changes
        Hide
        Aparup Banerjee added a comment -

        Hi

        (sorry for the spam, just wanted to watch lots of currently open issues)

        Show
        Aparup Banerjee added a comment - Hi (sorry for the spam, just wanted to watch lots of currently open issues)
        Hide
        Aparup Banerjee added a comment -

        Hi Marina, could you link the smaller issues you mentioned?

        Show
        Aparup Banerjee added a comment - Hi Marina, could you link the smaller issues you mentioned?
        Hide
        Michael de Raadt added a comment -

        Apu asked me to see which if the issues in this list had been fixed/changed.

        REGISTERING A NEW PLUGIN
        There is now a link to the validation process, including structure information.
        The website link is no longer added to each version.
        If no logo is provided, a default image is used instead of a broken image.
        Errors are gone after saving a plugin.

        AFTER REGISTERING
        The author's name is more prominent with a pretty picture.
        I now realise what the "traffic light" icon relates to, but perhaps this should say "Approved" instead of "Available".
        Plugin versions are now clearly associated with Moodle versions.
        The Docs tab is gone.
        A version is no longer automatically downloaded when a user clicks the download tab.
        The availability of plugin versions is now clearer, however, like plugins, this should say "Approved" instead of "Available".
        Whatever I was referring to in installation instructions is not there any more, but what is there seems OK.

        EDITING A CONTRIBUTED PLUGIN / ADDING A VERSION
        Errors reported are now gone.
        There is no link to help when uploading a new version, but I guess if you don't know at this stage, you're stuffed anyway.
        You can now indicate what Moodle version the new plugin version is for.
        Moodle version is shown with version info.
        I'm not sure if it is clear what previous version means, but we've debated that long enough now.
        The fields you can add when uploading a new version are still inconsistent with the new upload form.

        None of the items above are really critical. I wouldn't be concerned if this was closed now.

        Show
        Michael de Raadt added a comment - Apu asked me to see which if the issues in this list had been fixed/changed. REGISTERING A NEW PLUGIN There is now a link to the validation process, including structure information. The website link is no longer added to each version. If no logo is provided, a default image is used instead of a broken image. Errors are gone after saving a plugin. AFTER REGISTERING The author's name is more prominent with a pretty picture. I now realise what the "traffic light" icon relates to, but perhaps this should say "Approved" instead of "Available". Plugin versions are now clearly associated with Moodle versions. The Docs tab is gone. A version is no longer automatically downloaded when a user clicks the download tab. The availability of plugin versions is now clearer, however, like plugins, this should say "Approved" instead of "Available". Whatever I was referring to in installation instructions is not there any more, but what is there seems OK. EDITING A CONTRIBUTED PLUGIN / ADDING A VERSION Errors reported are now gone. There is no link to help when uploading a new version, but I guess if you don't know at this stage, you're stuffed anyway. You can now indicate what Moodle version the new plugin version is for. Moodle version is shown with version info. I'm not sure if it is clear what previous version means, but we've debated that long enough now. The fields you can add when uploading a new version are still inconsistent with the new upload form. None of the items above are really critical. I wouldn't be concerned if this was closed now.
        Hide
        Marina Glancy added a comment -
        • "Available" means "Approved"+"Visible". There are also options to hide the plugin/version (only plugin admin may hide plugin).
        • The link to help when uploading new version is the settings text managed by website admin (Martin usually does it)
        • leaving upload forms to Apu, not really sure what Michael meant there
        Show
        Marina Glancy added a comment - "Available" means "Approved"+"Visible". There are also options to hide the plugin/version (only plugin admin may hide plugin). The link to help when uploading new version is the settings text managed by website admin (Martin usually does it) leaving upload forms to Apu, not really sure what Michael meant there
        Hide
        Aparup Banerjee added a comment -

        seems concerns here were addressed to satisfaction. closing. (open a specific issue if needed)

        Show
        Aparup Banerjee added a comment - seems concerns here were addressed to satisfaction. closing. (open a specific issue if needed)

          People

          • Votes:
            1 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development