: First, I'm not about to second-guess this. I wouldn't like to lose the
: ability to download a full doc to search offline, but it looks like
: this solution allows that since there is a PDF version after all.

I also like being able to officially "release" the guide, and doing so via 
PDF will still be possible.

But the other nice thing is that this will make it easy to 
maintain "branches" of the ref guide in git, and publish those with 
releases as well -- so you can edit the docs on master, and backport the 
docs to the branch_6x at the same you backport the feature, and we can 
publish HTML versions of the guide right along side the javadoc docs for 
each version of solr.

: As you know, every time I try to edit he CWiki I come whimpering to
: you or Hoss. Sounds like this solution will reduce the volume of my
: whimpering which is a good thing. I so loathe Confluence that find

Ideally yes -- a lot of the problems we have with confluence today stem 
from the "WYSI-kind-of-WYG" mentality of it's editor, and the fact that it 
sometimes preserves html styling you can't see until the PDF is published 
(especially when you copy/paste).  Most of that pain should go away 
because the adoc files will be plain text.  (Any markup langauge has it's 
share of "wait, how do i get get formatting XYZ?" but being plain text 
files in git will make it a lot easier to spot mistakes in diffs -- as 
opposed to confluence with it's "heres a historical diff that is also in 
rendered HTML, so good luck noticing that there is an extra span with a 
css class that affects the PDF but isn't mentioned in the web stylesheet"

: I downloaded AsciidocFX and it looks quite usable. There may be better
: tools out there but that was fast to find and I could work with it. I
: see a Chrome extension, IntelliJ plugin etc. so it looks like there
: are a variety of ways to go about all this.

yeah -- just like java IDE/editor choices can be very personal, 
people will also be free to choose any tooling they want for editing 
asciidoc files -- which is another nice win over the web based confluence 
editor.  The trick will be having good automation in place to build the 
HTML & PDF output formats from the source documents, and give helpful 
feedback/errors about any weirdness that we can detect in scripts.  I plan 
on working to help cassandra with the "ongoing automation" when i get back 
from vacation in a few weeks.  

(at the moment, I'm spending my last few days before vacation tyring to 
better automate the confluence->(clean)asciidoc conversion so 
cassandra can iterate faster on demos of the full guide)

: > If reaction is positive, my next step will be to expand the demo
: > online with a full copy of the Ref Guide instead of the current small
: > set.



-Hoss
http://www.lucidworks.com/

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to