[
https://issues.apache.org/jira/browse/SOLR-12930?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16665207#comment-16665207
]
Cassandra Targett commented on SOLR-12930:
------------------------------------------
bq. Or we could aim for a new asciidoctor powered solr-developerguide in git...
Oh my god, how is it I didn't think of that?
Seriously, though, this is an idea worth exploring - we already have docs on
"how to write the Ref Guide" in asciidoc, and we can make a new area of our
website to host it. If we don't try to put it in the Ref Guide or need to
publish a PDF as the "official" doc, some of the strictness we have for the Ref
Guide can be relaxed to make it easier.
My personal recommendation would be to write the content into separate files,
but publish it in a single page format, similar to how HBase does it:
https://hbase.apache.org/book.html#developer (they mix user docs & dev docs
together, so ignore that part - what I mean is we could present it similarly as
a single page, but with just dev doc content on a single page with a TOC on the
left or right side). Doing that is incredibly simple with OOB Asciidoctor - we
wouldn't even need Jekyll in this case - and it would be easy to set up a
simple Ant target for it.
> 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]
