[NUTCH-2658] Add README file to all plugins in src/plugin

• Type: Improvement
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 1.15
• Fix Version/s: 1.16
• Component/s: documentation, plugin
• Assignee: Unassigned
• Reporter: Jorge Luis Betancourt Gonzalez
• Created: 17/Oct/18 08:43
• Updated: 28/Jan/21 13:56
• Resolved: 06/Jan/19 11:20

Description

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.

Issue Links

• links to: GitHub Pull Request #398

Sub-Tasks

• Add README.md file to all indexer writers plugins: Closed
• Add README.md file to all exchange plugins: Closed