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

["Hudson (JIRA)" <ji...@apache.org>]

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

Hudson commented on NUTCH-2658:
-------------------------------

SUCCESS: Integrated in Jenkins build Nutch-trunk #3584 (See [https://builds.apache.org/job/Nutch-trunk/3584/])
NUTCH-2658 Adding the fields required by the index-links plugin to the (betancourt.jorge: [https://github.com/apache/nutch/commit/45098e7964f100fe0fb5dfa6cd370a2d966a50dc])
* (edit) conf/schema.xml


> 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)