Re: Proof of concept for Cassandra docs conversion

2020-06-29 Thread Jon Haddad
Wow, this is *really* nice. * The live search is awesome * Loving having the versions in the documentation dropdown * The UI is much nicer than the current version I think the CQL docs are the biggest unknown at this point. Very much looking forward to that. I originally doubted it would be pos

Re: Proof of concept for Cassandra docs conversion

2020-06-24 Thread Lorina Poland
I just wanted to update everyone on the POC for the docs website: https://polandll.github.io/site/Cassandra/4.0/index.html I've added lunr search to the site, and (mostly finished) custom header and footer that matches the current site. I've also added a dummy 3.11 version (same source files as 4.

Re: Proof of concept for Cassandra docs conversion

2020-06-12 Thread Lorina Poland
Thanks for the vote of confidence, Anthony! Yes, search can be integrated into the antora SSG; I just haven't pursued that yet. Obviously a feature that is needed. Lorina On Thu, Jun 11, 2020 at 7:13 PM Anthony Grasso wrote: > I agree as well. Nice work, Lorina! > > This POC is a really good

Re: Proof of concept for Cassandra docs conversion

2020-06-11 Thread Anthony Grasso
I agree as well. Nice work, Lorina! This POC is a really good start. It has a bit more of a modern feel to it. The navigation bar on the side makes the information very accessible. This is a must for technical documentation. Would it be possible to have a search bar somewhere on the site? I think

Re: Proof of concept for Cassandra docs conversion

2020-06-11 Thread Lorina Poland
Thanks for the feedback, Murukesh! As I mentioned, the editing to fix all the formatting is not completed, but I wanted to share the work so far to get feedback. I have not tailored most of the styling of the website. I literally used the default antora UI, only changing the banner to green and ad

Re: Proof of concept for Cassandra docs conversion

2020-06-11 Thread Lorina Poland
Just a note, to emphasize - I did not complete the conversion of all the files from rSt to asciidoc yet. I wanted feedback that this direction seemed acceptable to everyone. Sylvain, I'll check out the tool you mention and see if it provides better translation. A one-time conversion effort is just

Re: Proof of concept for Cassandra docs conversion

2020-06-11 Thread Jon Haddad
Agreed. This is an awesome POC in a pretty short period of time. I suspect with a little polish and cleanup this will be an improvement over the existing site in every way. Thanks for putting this together, Lorina! On Thu, Jun 11, 2020 at 7:36 AM Joshua McKenzie wrote: > Left bar navigation a

Re: Proof of concept for Cassandra docs conversion

2020-06-11 Thread Murukesh Mohanan
Is the AsciiDoc source also on GitHub? Some things that I noticed: - The FAQ sidebar navigation is great! The TOC list at the top isn't needed at all now. - In the breadcrumb trail (e.g., ASCIIDOC_POC > Cassandra > FAQ, or ASCIIDOC_POC > Cassandra Documentation > Glossary), *Cassandra* in the Ca

Re: Proof of concept for Cassandra docs conversion

2020-06-11 Thread Sylvain Lebresne
Agreed the navigation is nicer. The content rst conversion is however far from perfect, especially in the CQL parts. The grammar parts are all broken, most tables are really weird (example: https://polandll.github.io/site/ASCIIDOC_POC/4.0/cassandra/cql/types.html) and we lost almost all linking in

Re: Proof of concept for Cassandra docs conversion

2020-06-11 Thread Ekaterina Dimitrova
I told the same to Lorina in person, +1 more fan On Thu, 11 Jun 2020 at 10:36, Joshua McKenzie wrote: > Left bar navigation and content navigation on top right are both > aesthetically and usability-wise quite superior IMO (comparing to > https://cassandra.apache.org/doc/latest/getting_started/c

Re: Proof of concept for Cassandra docs conversion

2020-06-11 Thread Joshua McKenzie
Left bar navigation and content navigation on top right are both aesthetically and usability-wise quite superior IMO (comparing to https://cassandra.apache.org/doc/latest/getting_started/configuring.html). I'm a fan. On Wed, Jun 10, 2020 at 2:21 PM Lorina Poland wrote: > Hello all! > > Based on

Proof of concept for Cassandra docs conversion

2020-06-10 Thread Lorina Poland
Hello all! Based on an earlier discussion about moving the OSS C* docs to asciidoc, to allow more flexibility in maintaining the docs, I've done a proof of concept about what it would take to accomplish a conversion. I converted rSt files to asciidoc files using pandoc, did some additional editing