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

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

FAILURE: Integrated in Jenkins build Nutch-trunk #3593 (See 
[https://builds.apache.org/job/Nutch-trunk/3593/])
NUTCH-2658 Add README for the index-links plugin (jorge-luis.betancourt: 
[https://github.com/apache/nutch/commit/f79a5af4fe52ae905d6ce77f891911305d1362a9])
* (add) src/plugin/index-links/README.md


> 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
>    Affects Versions: 1.15
>            Reporter: Jorge Luis Betancourt Gonzalez
>            Priority: Trivial
>             Fix For: 1.16
>
>
> 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)

Reply via email to