[
https://issues.apache.org/jira/browse/SOLR-12930?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16665801#comment-16665801
]
Cassandra Targett commented on SOLR-12930:
------------------------------------------
bq, I thought it must be Asciidoc and then publish a current working version to
cwiki
Oh god, no, we dropped cwiki entirely. It's all hosted on the Solr website now.
I did look into pushing Asciidoc content to Confluence, and the main tools out
there are kind of old, or only work with old versions. I don't know that's the
best approach anyway - it's something that could break at any time if one
version changes on either side.
I've come up with a simple example project that uses Asciidoctor with an Ant
target to generate an HTML file, if that's what we want. It's all kind of quick
& dirty - a bunch of stuff would need to be done to fully integrate it with the
project for real - but it shows the basic concepts if you aren't familiar with
"what's the basic Asciidoctor can do" vs. "what did we add to Asciidoctor for
our needs". Just unzip the {{solr-dev-docs.zip}}, run the {{ant build-devdocs}}
target, and then look in the {{build/html}} directory for {{dev-docs.html}}.
Even without generating an HTML we publish, one thing I was thinking is we
could add a new directory at {{lucene-solr/solr/docs}} that includes the
dev-docs content + the ref guide. But I'm not sure I care all that much about
where the dev docs go; it just seemed they were docs and all docs-things could
go together.
> 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]
