Jorge Luis Betancourt Gonzalez created NUTCH-2658:
-----------------------------------------------------
Summary: 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
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)
