[
https://issues.apache.org/jira/browse/SOLR-12930?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16665659#comment-16665659
]
Cassandra Targett commented on SOLR-12930:
------------------------------------------
I think we'd have to pick either use cwiki or use the slimmed-down Ref Guide
(Asciidoctor) way. I'm not coming up with a way to have both (keep source with
code & also publish to cwiki) off the top of my head, but I'll do a little bit
of research to see what's out there. Maybe we can - we'd still have to have
some kind of "publish" process, though.
The benefit of cwiki is instant publication as soon as you hit enter to save
the page, but the con is your docs are in some other repo separate from the
code it's trying to help you use. It's pretty much the exact opposite pro/con
for the Asciidoctor way - your docs are in the same repo as your code, but you
have to have a publication process of some kind to get it into a
browser-readable form like HTML.
I'll come up with a strawman of sorts for publication process so people get a
feel for what that would be like so we can try to get this together quickly.
> Add great developer documentation for writing tests.
> ----------------------------------------------------
>
> Key: SOLR-12930
> URL: https://issues.apache.org/jira/browse/SOLR-12930
> Project: Solr
> Issue Type: Sub-task
> Security Level: Public(Default Security Level. Issues are Public)
> Components: Tests
> Reporter: Mark Miller
> Priority: Major
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
