[jira] [Commented] (NUTCH-2658) Add README file to all plugins in src/plugin

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/NUTCH-2658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16735157#comment-16735157 ] 

ASF GitHub Bot commented on NUTCH-2658:
---------------------------------------

sebastian-nagel commented on pull request #398: NUTCH-2658 Add README for the index-links plugin
URL: https://github.com/apache/nutch/pull/398
 
 
   
 
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Add README file to all plugins in src/plugin
> --------------------------------------------
>
>                 Key: NUTCH-2658
>                 URL: https://issues.apache.org/jira/browse/NUTCH-2658
>             Project: Nutch
>          Issue Type: Improvement
>          Components: documentation, plugin
>            Reporter: Jorge Luis Betancourt Gonzalez
>            Priority: Trivial
>
> Since we've migrated a good portion of our workflow to Github we could consider adding a {{README.md}} file to the root of each plugin in {{src/plugins}}. 
> This is a good place to have plugin-specific documentation. Wich fields the plugin adds to the indexer, which configuration options, etc. Also, since the README.md is rendered by Github automatically is a good link to point users.
> I think that a good example is the {{indexer-cloudsearch}} plugin, on top of that it's a good source of information to point users when asking questions regarding a specific plugin.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)