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 possible to convert everything for 4.0, but I am very optimistic now! On Wed, Jun 24, 2020 at 10:50 AM Lorina Poland <lor...@datastax.com> wrote: > 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.0-rc5) to demonstrate having selectable doc > versions. Still manually editing files, so yes - I know there are still > pages messed up. And the Last/Next buttons - trying to figure out the > implementation. > > But all comments appreciated and solicited. > Thanks, > Lorina > Lorina Poland > e. lor...@datastax.com > w. www.datastax.com > > > > On Thu, Jun 11, 2020 at 7:13 PM Anthony Grasso <anthony.gra...@gmail.com> > wrote: > > > 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 > > this would be useful to allow a user to navigate quickly to something > they > > know they are after e.g. a nodetool command or configuration setting. > > > > Kind regards, > > > > On Fri, 12 Jun 2020 at 02:02, Jon Haddad <j...@jonhaddad.com> wrote: > > > > > 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 <jmcken...@apache.org> > > > 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/configuring.html > > > ). > > > > > > > > I'm a fan. > > > > > > > > On Wed, Jun 10, 2020 at 2:21 PM Lorina Poland <lor...@datastax.com> > > > wrote: > > > > > > > > > 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, and use antora (antora.org) as a static > > site > > > > > generator to build the docs. The result is here: > > > > > > > > > > > > > > > > > > > > https://urldefense.proofpoint.com/v2/url?u=https-3A__polandll.github.io_site_ASCIIDOC-5FPOC_4.0_cassandra_getting-5Fstarted_configuring.html-23changing-2Dthe-2Dlocation-2Dof-2DdirectoriesThe&d=DwIBaQ&c=adz96Xi0w1RHqtPMowiL2g&r=bL2UpIjL4Mm1mCbqWThJUiPD-CmTXMALsIT2Ta-KfGk&m=57qpHuofWcJzqnGIF_M7WxOaLaNAKs4buNLWOFM0vMs&s=wTEu0dtK7H2_LkcYq7Xxw2VjPDLl-QSVb4tScXcS6mk&e= > > > > > editing of the docs is NOT complete, but I completed enough to feel > > > > > confident that this process can be accomplished. Some YAML > > > > > configuration for antora was required, and I did a minimum of UI > > > > > configuration (added color banner, logo). Looking for feedback and > > > > > questions anyone may have. > > > > > > > > > > Thanks, > > > > > > > > > > Lorina Poland (DataStax tech writer) > > > > > > > > > > > > > > >
