[
https://issues.apache.org/jira/browse/CASSANDRA-20195?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17916846#comment-17916846
]
Brad Schoening edited comment on CASSANDRA-20195 at 1/24/25 10:05 PM:
----------------------------------------------------------------------
[~mck] 5.0, yes, it's simple, PR for 5.0 added.
The 4.0 and 4.1 files have 100+ lines of differences, and different from
each-other. it doesn't seem worth the effort to manually reapply 800 lines of
changes. I think cql_singlefile is used only by CQLSH when the local CQL.html
wasn't install – this is the case if you 'pip install cqlsh' which doesn't
bundle CQL.html. But the pypl.org version latest is 5.0, so the relevance of
this for 4.0/4.1 seems minor.
was (Author: bschoeni):
[~mck] 5.0, yes, it's simple.
The 4.0 and 4.1 files have 100+ lines of differences, and different from
each-other. it doesn't seem worth the effort to manually reapply 800 lines of
changes. I think cql_singlefile is used only by CQLSH when the local CQL.html
wasn't install – this is the case if you 'pip install cqlsh' which doesn't
bundle CQL.html. But the pypl.org version latest is 5.0, so the relevance of
this for 4.0/4.1 seems minor.
> 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
> Fix For: 4.0.x, 4.1.x, 5.0.x, 5.x
>
> Attachments: cql_singlefile.html, image-2025-01-08-13-25-42-002.png,
> image-2025-01-08-13-26-48-829.png, screenshot-1.png, screenshot-2.png
>
> Time Spent: 1h 10m
> 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]
