You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Erick Erickson (JIRA)" <ji...@apache.org> on 2013/03/16 19:42:13 UTC
[jira] [Commented] (SOLR-555) Autogenerate "user" docs about
"plugins" from code
[ https://issues.apache.org/jira/browse/SOLR-555?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13604352#comment-13604352 ]
Erick Erickson commented on SOLR-555:
-------------------------------------
Hossman:
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: https://issues.apache.org/jira/browse/SOLR-555
> 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: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org