Hi Lorina and Mick,

I've raised CASSANDRA-16066
<https://issues.apache.org/jira/browse/CASSANDRA-16066> to capture the
effort required to carry out the work of converting the markdown to
asciidoc. As part of the work, I think all content files should be moved to
cassandra/doc. This would give a clear separation of concerns;
 - cassandra/doc contains the material (asciidoc) that is converted to the
website content.
 - cassandra-website hosts the live content and contains all the UI
resources (html templates, css, js, images) that style the content.

Document authors only need to touch one repository to make content edits.
It also means they only need to run Antora in one location to generate the
content.

The proposal is a fairly common way of publishing content with Antora and
there are a number of examples out there of how to do this. Note, there
would be no alteration to design/content/layout of the website itself. The
only things changing would be the layout of the repositories and the tools
generating the content.

I'm happy to help with the changes if we think this is a good way to go.

Regards,
Anthony

On Thu, 6 Aug 2020 at 05:33, Lorina Poland <lor...@datastax.com> wrote:

> The one issue I see with your suggestion about versioned/non-versioned docs
> is that the cassandra/doc repo will have asciidoc files, and currently, all
> the items in the cassandra-website repo are in markdown. There are possible
> solutions (use antora for the website, put the non-versioned docs in their
> own repo which antora can use for building, for example), but that needs
> exploration.
>
> Lorina Poland
>
>
>
>
> On Wed, Aug 5, 2020 at 12:06 PM Michael Semb Wever <m...@apache.org> wrote:
>
> >
> >
> > > See that here:
> > >
> >
> https://docs.google.com/document/d/1aeNtgyPAsKcNa0GSKvl2ywlFEj30714ry4Sb5turWeE/edit?usp=sharing
> > >
> > > This outline is not complete, just my initial scribblings. Certainly
> > > collaboration would be welcome.
> >
> >
> > This is awesome Lorina. It would also be great to see all non-versioned
> > docs moved out of the cassandra repository and into the cassandra-website
> > repository (where they become easier to update).
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscr...@cassandra.apache.org
> > For additional commands, e-mail: dev-h...@cassandra.apache.org
> >
> >
>

Reply via email to