[
https://issues.apache.org/jira/browse/NUTCH-2658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16653353#comment-16653353
]
Sebastian Nagel commented on NUTCH-2658:
----------------------------------------
In general, a good idea to bundle the plugin documentation and make them
available under a uniform path. At present, we the documentation is spread over
4 different places:
- the Wiki, e.g., https://wiki.apache.org/nutch/IndexReplace
- the [API
doc|http://nutch.apache.org/apidocs/apidocs-1.15/overview-summary.html] linking
to the package.html / package-info.java of the plugin packages. Some plugins
provide a usage description their or in the implementing class.
- few plugins already have a README.md, e.g.,
[indexer-cloudsearch|https://github.com/apache/nutch/tree/master/src/plugin/indexer-cloudsearch]
- nutch-default.xml for properties
In doubt, I would opt for moving documentation to the code because the code is
versioned while our Wiki is not, resp. it's difficult to link a Nutch version
(eg. 1.14) and the appropriate description. This would be also a good idea for
to the tutorial. The drawback - we really need to maintain the READMEs - once
released we cannot change the documentation.
> 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)
