You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@nutch.apache.org by "Jorge Luis Betancourt Gonzalez (JIRA)" <ji...@apache.org> on 2018/10/17 09:34:00 UTC
[jira] [Commented] (NUTCH-2658) Add README file to all plugins in
src/plugin
[ https://issues.apache.org/jira/browse/NUTCH-2658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16653252#comment-16653252 ]
Jorge Luis Betancourt Gonzalez commented on NUTCH-2658:
-------------------------------------------------------
I'm thinking of having at least 2 general sections:
* Configuration: Covers all parameters that are included in the nutch-default.xml (although could be a bit of a repetition)
* Fields: Includes information about which fields should be added to your storage backend configuration (if applicable).
Including documentation on how to configure Solr fields would be a nice default configuration, although we support different backends.
> 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)