[
https://issues.apache.org/jira/browse/NUTCH-2658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16653495#comment-16653495
]
Jorge Luis Betancourt Gonzalez commented on NUTCH-2658:
-------------------------------------------------------
[~wastl-nagel] exactly what I was thinking. Right now in order to configure a
given plugin you need to look at the nutch-default.xml to see what options are
available, and read the documentation from there. If it's an indexing plugin
you need to check the schema, or in the worst case the actual code to figure
out what fields are going to be added.
I consider that at least these 2 components should be made more visible to the
users, the advantage of the README is that lives right next to the code so it's
easier to "remember" to update it.
[~yossi] I agree that having the documentation also on the Wiki is very helpful
and the README it's not intended to replace that.
+1 on generating the wiki from the README (or something else) this will at
least guarantees that is updated with each release.
We can also add a check/step to the release procedure to check if any new
plugins have been added and if the README is there. Of course, there is always
the risk that the README contains dummy/not useful data. But through PRs we can
keep an eye on that.
As a side note, I kind of like how elasticsearch has it's documentation
versioned and updated per release. Not sure how to integrate this with our wiki.
> 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)
