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 adding the
Cassandra logo. So all the navigation can use some additional work; in
fact, I only created the navigation files for 2-3 of the sections. Same
with the breadcrumbs, more work to make it production-worthy. (But aren't
those breadcrumbs cool?!)

I have tried a few different conversions. I believe I did try rSt-> HTML ->
asciidoc, but I'll check my files again.

I have 4 separate sources of files used to create this POC, some local on
my Macbook, and some publicly available:

So, right now, the pieces of the process are in 4 locations:

1. docs-site (local - where I run antora)
2. a clone of https://gitlab.com/antora/antora-ui-default (local - where I
made minimal look and feel changes)
3.
https://github.com/polandll/cassandra-examples/tree/master/rst-to-asciidoc-tests/ASCIIDOC
(where
I am storing the asciidoc files that I’ve converted/editing)
4. https://github.com/polandll/polandll.github.io (where the prototype
docs website
is located)
Feel free to check out the *.adoc files in the 3rd resource, but know that
I am actively making changes there.

Thanks,
Lorina



On Thu, Jun 11, 2020 at 8:15 AM Murukesh Mohanan <murukesh.moha...@gmail.com>
wrote:

> 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
> Cassandra pages isn't a link but Cassandra Documentation is.
> - Some of the code blocks are off (e.g,
>
> https://urldefense.proofpoint.com/v2/url?u=https-3A__polandll.github.io_site_ASCIIDOC-5FPOC_4.0_cassandra_cql_indexes.html-23create-2Dindex-2Dstatement&d=DwIBaQ&c=adz96Xi0w1RHqtPMowiL2g&r=bL2UpIjL4Mm1mCbqWThJUiPD-CmTXMALsIT2Ta-KfGk&m=8C0qNdZj2XHZ-aA4ZjwgWI_Y6Nael_kjR7Wp-6CiOLU&s=Eg_JbhzOrbE1c5RgXi1UHjOQ-Np-uTmzDyPukPwWvfE&e=
> ,
>
> https://urldefense.proofpoint.com/v2/url?u=https-3A__polandll.github.io_site_ASCIIDOC-5FPOC_4.0_cassandra_cql_mvs.html&d=DwIBaQ&c=adz96Xi0w1RHqtPMowiL2g&r=bL2UpIjL4Mm1mCbqWThJUiPD-CmTXMALsIT2Ta-KfGk&m=8C0qNdZj2XHZ-aA4ZjwgWI_Y6Nael_kjR7Wp-6CiOLU&s=emL2s3ZZkCU5-L2Zg0-mlYKamtcCh2NkqVSu5Wn41Ss&e=
> )
> - Pandoc clobbered the "MV select" part in
>
> https://urldefense.proofpoint.com/v2/url?u=https-3A__polandll.github.io_site_ASCIIDOC-5FPOC_4.0_cassandra_cql_mvs.html&d=DwIBaQ&c=adz96Xi0w1RHqtPMowiL2g&r=bL2UpIjL4Mm1mCbqWThJUiPD-CmTXMALsIT2Ta-KfGk&m=8C0qNdZj2XHZ-aA4ZjwgWI_Y6Nael_kjR7Wp-6CiOLU&s=emL2s3ZZkCU5-L2Zg0-mlYKamtcCh2NkqVSu5Wn41Ss&e=
> into the preceding note.
>
> I wonder if it will be worth it to try rSt -> HTML (using the current build
> tools) -> AsciiDoc (using Pandoc).
>
> Yours,
> Murukesh Mohanan
>
>
> On Thu, 11 Jun 2020 at 03:21, 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=8C0qNdZj2XHZ-aA4ZjwgWI_Y6Nael_kjR7Wp-6CiOLU&s=a_fQx4FtvGnSkExAfzZM2BZAiaOmEeo9EA8DXjAYKz4&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)
> >
>

Reply via email to