lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Erick Erickson (JIRA)" <>
Subject [jira] [Commented] (SOLR-555) Autogenerate "user" docs about "plugins" from code
Date Sat, 16 Mar 2013 18:42:13 GMT


Erick Erickson commented on SOLR-555:


Is there stuff worth keeping here? Doc improvement is really worthwhile, but this has lingered
for a looong time. Or should we close it since it hasn't been touched in so long?
> Autogenerate "user" docs about "plugins" from code
> --------------------------------------------------
>                 Key: SOLR-555
>                 URL:
>             Project: Solr
>          Issue Type: Improvement
>            Reporter: Hoss Man
>            Assignee: Hoss Man
>         Attachments: SOLR-555.patch, SOLR-555.patch, SOLR-555.patch, SOLR-555.patch,
SOLR-555.patch, SOLR-555.patch
> Our current strategy of using javadocs for "developer" documentation and the wiki for
documenting "user" features only gets us so far -- among other things, it makes it hard to
include the "user" documentation in our releases, but it also results in a disconnect between
when code changes and when documentation gets updated.
> in an ideal world, "user" documentation would live in the code right along side the implementation,
just like with javadocs -- but the standard set of information displayed by javadocs isn't
very user friendly.  we should find a better way to allow us to "edit" the info about how
to use a plugin right along side the code for that plugin and generate user friendly documentation
from that.

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see:

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message