[
https://issues.apache.org/jira/browse/NUTCH-2658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16653368#comment-16653368
]
Yossi Tamari commented on NUTCH-2658:
-------------------------------------
I disagree regarding putting the documentation in the code. This is not helpful
for new users and users who are not Java coders. They can't be expected to
navigate to src/plugin/indexer-cloudsearch to find the documentation for that
plugin.
The README.md files are also less likely to appear high in Google results,
compared to the Wiki.
The real problem is that the Wiki, and specifically PluginCentral, is not
properly maintained. Do you think the README files will be maintained better?
Maybe we can add a build step that will copy the information from the README to
the Wiki on release?
> 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)
