[ 
https://issues.apache.org/jira/browse/CASSANDRA-20195?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Brad Schoening updated CASSANDRA-20195:
---------------------------------------
    Description: 
The 
[cql_singlefile.html|https://cassandra.apache.org/doc/latest/cassandra/developing/cql/cql_singlefile.html]
 has invalid markup.

Invalid 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 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!

  was:
The 
[cql_singlefile.html|https://cassandra.apache.org/doc/latest/cassandra/developing/cql/cql_singlefile.html]
 has invalid markup.

Invalid markup requiring conversion:
* bc(syntax) to [source, bnf]
* bc(sample) to [source, cql]
* p. indicates end of code block, to four dashes (----)

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!


> 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
>
>
> The 
> [cql_singlefile.html|https://cassandra.apache.org/doc/latest/cassandra/developing/cql/cql_singlefile.html]
>  has invalid markup.
> Invalid 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 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: commits-unsubscr...@cassandra.apache.org
For additional commands, e-mail: commits-h...@cassandra.apache.org

Reply via email to