[
https://issues.apache.org/jira/browse/CASSANDRA-20195?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17914175#comment-17914175
]
Michael Semb Wever edited comment on CASSANDRA-20195 at 1/17/25 6:11 PM:
-------------------------------------------------------------------------
Thanks for the prompt [~brandon.williams]
We generate a html version from `ant generate-cql-html`
We should include the generated html file into the antora docs, instead of
having to maintain the alternative source file in asciidoc format.
We are doing something similar in CASSANDRA-19915 for the native protocol spec
pages.
See https://github.com/apache/cassandra/pull/3714/files
Generate/copy the html file into `modules/cassandra/assets/attachments/` and
then create a near-empty .adoc holder file that includes the html file. (No
need for a script here, as the Makefile can just call generate-cql-html and do
location change.)
[~bschoeni], what are your thoughts ? it seems relatively similar amount of
work to do this^ instead…
was (Author: michaelsembwever):
Thanks for the prompt [~brandon.williams]
We generate a html version from `ant generate-cql-html`
We should include the generated html file into the antora docs, instead of
having to maintain the alternative source file in asciidoc format.
We are doing something similar in CASSANDRA-19915 for the native protocol spec
pages.
See https://github.com/apache/cassandra/pull/3714/files
Generate/copy the html file into `modules/cassandra/assets/attachments/` and
then create a near-empty .adoc holder file that includes the html file. (No
need for a script here, as the Makefile can just call generate-cql-html and do
location change.)
> CQL single file doc page has obsolete and invalid markup
> --------------------------------------------------------
>
> Key: CASSANDRA-20195
> URL: https://issues.apache.org/jira/browse/CASSANDRA-20195
> Project: Apache Cassandra
> Issue Type: Bug
> Components: Documentation/Website
> Reporter: Brad Schoening
> Assignee: Brad Schoening
> Priority: Normal
> Attachments: image-2025-01-08-13-25-42-002.png,
> image-2025-01-08-13-26-48-829.png
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> The
> [cql_singlefile.html|https://cassandra.apache.org/doc/latest/cassandra/developing/cql/cql_singlefile.html]
> has invalid markup. The legacy markup in the file resembles Wiki Markup.
> Old markup requiring conversion:
> * bc(syntax) to [source, bnf]
> * bc(sample) to [source, sql]
> * p. indicates end of code block, to four dashes (----)
> * code in AsciiDoc doesn't require escaping curly bracket
> * back quotes in code changed to regular single quotes
> 'sql', 'bnf' and 'text' are source language names supported in AsciiDocs
> Pygments highlighter.
> For example, invalid formatting in
> [cql_singlefile.html|https://cassandra.apache.org/doc/latest/cassandra/developing/cql/cql_singlefile.html]:
> !image-2025-01-08-13-26-48-829.png!
> Correct formatting of same content on DDL
> ([ddl.html|https://cassandra.apache.org/doc/latest/cassandra/developing/cql/ddl.html])
> page:
> !image-2025-01-08-13-25-42-002.png!
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
