Uploaded image for project: 'Picard Website'
  1. Picard Website
  2. PW-14

Document the process of adding plugins to the plugin list

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Normal Normal

      With the old Wiki it was quite clear for everybody how to add new plugins (upload them somewhere, edit the wiki). I think the new process of adding plugins should be documented on the Picard website.

          [PW-14] Document the process of adding plugins to the plugin list

          Philipp Wolfer added a comment - - edited

          Hi, thanks for wanting to help out. Yes, I think that task is still available.

          As we have a new documentation for Picard for a while I think this information should be added to the existing documentation about writing plugins at https://picard-docs.musicbrainz.org/en/extending/plugins.html . The documentation is currently maintained at https://github.com/rdswift/picard-docs , updates to this are always welcomed, see also https://picard-docs.musicbrainz.org/en/about_picard/contributing.html

          Once we have the documentation itself we probably should also add a note about this with a link to the documentation at https://picard.musicbrainz.org/plugins/ . That page on the website is at https://github.com/metabrainz/picard-website/blob/master/website/frontend/templates/plugins.html

          As for the process to add plugins this is currently not even partially documented anywhere I think. In short the process involves:

          1. Forking https://github.com/metabrainz/picard-plugins
          2. Add your plugin to a subdirectory in the plugins/ directory of this repository (ideally in a branch). This must be based on the 2.0 branch.
          3. Submit a pull request on Github to have the plugin included
          4. The plugin will be available the next time we update the website (this currently is one of the weak points, as updating the website can only be done manually by a MetaBrainz administrator)

          Note: There have been talks about a complete redesign of the plugins mechanism, especially also about the way plugins get distributed. But this has neither been fully discussed nor are there concrete plans (and currently it doesn't look like anyone has time for it in the near to mid future). So for now it makes still sense to document the process as it currently is.

          Philipp Wolfer added a comment - - edited Hi, thanks for wanting to help out. Yes, I think that task is still available. As we have a new documentation for Picard for a while I think this information should be added to the existing documentation about writing plugins at https://picard-docs.musicbrainz.org/en/extending/plugins.html . The documentation is currently maintained at https://github.com/rdswift/picard-docs , updates to this are always welcomed, see also https://picard-docs.musicbrainz.org/en/about_picard/contributing.html Once we have the documentation itself we probably should also add a note about this with a link to the documentation at https://picard.musicbrainz.org/plugins/ . That page on the website is at https://github.com/metabrainz/picard-website/blob/master/website/frontend/templates/plugins.html As for the process to add plugins this is currently not even partially documented anywhere I think. In short the process involves: Forking https://github.com/metabrainz/picard-plugins Add your plugin to a subdirectory in the plugins/ directory of this repository (ideally in a branch). This must be based on the 2.0 branch. Submit a pull request on Github to have the plugin included The plugin will be available the next time we update the website (this currently is one of the weak points, as updating the website can only be done manually by a MetaBrainz administrator) Note: There have been talks about a complete redesign of the plugins mechanism, especially also about the way plugins get distributed. But this has neither been fully discussed nor are there concrete plans (and currently it doesn't look like anyone has time for it in the near to mid future). So for now it makes still sense to document the process as it currently is.

          harshrj added a comment -

          I think I updated the assignee by mistake, please re-assign if some is already working on it or else I would be happy to take this task.

          harshrj added a comment - I think I updated the assignee by mistake, please re-assign if some is already working on it or else I would be happy to take this task.

          harshrj added a comment - - edited

          Hi, I would like to take this task if it is still available. Could you please direct me to the new process of adding plugins? 

          Also, the ticket mentions the process needs to be documented on the website, please brief where I can find the documentation file that updates the website?

           

          harshrj added a comment - - edited Hi, I would like to take this task if it is still available. Could you please direct me to the new process of adding plugins?  Also, the ticket mentions the process needs to be documented on the website, please brief where I can find the documentation file that updates the website?  

            harshrj harshrj
            outsidecontext Philipp Wolfer
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:

                Version Package