[
https://issues.apache.org/jira/browse/CASSANDRA-20195?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Brad Schoening updated CASSANDRA-20195:
---------------------------------------
Impacts: Docs (was: None)
Test and Documentation Plan:
This is a documentation only fix, although it involves AsciiDoc formatting.
I used IntelliJ formatted view to review the HTML rendering with source
formatting. Also ran asciidoc from the command line to verify results.
Status: Patch Available (was: In Progress)
This PR uses the 'sql', 'bnf' and 'text' source language names which are
supported in AsciiDocs Pygments highlighter.
> CQL single file doc page has obsolete or 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. It resembles Confluence Wiki Markup.
> Old markup requiring conversion:
> * bc(syntax) to [source, bnf]
> * bc(sample) to [source, cql]
> * p. indicates end of code block, to four dashes (----)
> * code in AsciiDoc doesn't require escaping curly bracket
> * change back quotes in code to regular single quotes
> For example:
> cql_singlefile.html:
> !image-2025-01-08-13-26-48-829.png!
>
> [ddl.html|https://cassandra.apache.org/doc/latest/cassandra/developing/cql/ddl.html]
> !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]
