[
https://issues.apache.org/jira/browse/CASSANDRA-20195?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17914239#comment-17914239
]
Brad Schoening edited comment on CASSANDRA-20195 at 1/17/25 9:08 PM:
---------------------------------------------------------------------
[~mck] one file sounds good, I don't know if it needs to be in the modules
directory, it's almost redundant with the content there. The primary purpose of
this file is as an online resource for cqlsh if the local CQL.html wasn't
installed (as it's not today with 'pip install cqlsh').
However, since the modules files are in AsciiDoc, it's a little awkward that
this file would be in textile as much of the content overlaps. For example, if
you add content to describe new functions to functions.adoc it would be nice to
be able to cut-n-paste it to the CQL help file in the same format.
was (Author: bschoeni):
[~mck] one file sounds good, I don't know if it needs to be in the modules
directory, it's almost redundant with the content there. The primary purpose of
the file is as an online resource for cqlsh if the local CQL.html wasn't
installed (as it's not today with 'pip install cqlsh').
However, since the modules files are in AsciiDoc, it's a little awkward that
this file would be in textile as much of the content overlaps. For example, if
you add content to describe new functions to functions.adoc it would be nice to
be able to cut-n-paste it to the CQL help file in the same format.
> 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]
