Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs fixes 20241206 #3729

Open
wants to merge 46 commits into
base: trunk
Choose a base branch
from
Open

Docs fixes 20241206 #3729

wants to merge 46 commits into from

Conversation

sarma1807
Copy link
Contributor

fixed several typos and asciidoc formatting errors in documentation

@sarma1807
Update vector-search-cycling.cql
ee6a49d 
bug fix on line 25
@sarma1807
Update data-modeling_conceptual.adoc
1a663b7 
pointing to the correct image
@sarma1807
Update data-modeling_rdbms.adoc
4cf7843 
pointing to the correct image
@sarma1807
Update data-modeling_queries.adoc
c4bda79 
pointing to the correct image
@sarma1807
Update data-modeling_logical.adoc
d8288c0 
pointing to the correct images
@sarma1807
Update data-modeling_physical.adoc
897380a 
pointing to the correct images
@sarma1807
Update data-modeling_refining.adoc
f37436c 
pointing to the correct image
@sarma1807
Update create_ks_trans_repl.cql
0ddfff5 
fixing a formatting error
@sarma1807
Update ddl.adoc
81afc5b 
fixing a formatting error
@sarma1807
Update 2i-check.result
f5e17a4 
TBD replaced with correct content
@sarma1807
Update mvs.adoc
86a9a24 
fixing formatting error and adding url to jira ticket
@sarma1807
Update functions.adoc
07c7cb1 
adding direct links to jira tickets
@sarma1807
Update security.adoc
c635e86 
fixing formatting errors
@sarma1807
Update no_revoke.cql
3eaebd6 
` (back-ticks) are not adding any value, so removing this formatting
@sarma1807
Update changes.adoc
9ee1ab3 
fixing few formatting errors
@sarma1807
Update SASI.adoc
64231aa 
fixing several formatting errors
@sarma1807
Update cql_singlefile.adoc
76863fc 
fixing asciidoc formatting error
@sarma1807
Update data-modeling.adoc
6d08776 
updating document title
@sarma1807
Update cass_jvm_options_file.adoc
669d94d 
fixing formatting errors
@sarma1807
Update cass_jvm_options_file.adoc
f187d56 
fixing formatting errors
@sarma1807
Update cass_jvm_options_file.adoc
5fc635d 
fixing formatting errors
@sarma1807
Update cdc.adoc
7aa40e8 
adding some context to the jira tickets
@sarma1807
Update tombstones.adoc
3d66659 
fixing formatting error
@sarma1807
Update topo_changes.adoc
8837f3a 
adding urls to jira tickets
@sarma1807
Update sstableverify.adoc
5f971c3 
adding urls for jira tickets
@sarma1807
Update use_tools.adoc
9aa0f38 
adding urls to jira tickets
@sarma1807
Update static.adoc
5b1b6ea 
fixing formatting issues
@sarma1807
Update static.adoc
da1a7fb 
fixing formatting issues
@sarma1807
Update cql-syntax-legend.adoc
e351446 
fixing formatting issues
@sarma1807
Update cql-syntax-legend.adoc
9048c33 
fixing formatting issues
@sarma1807
Update table-column-definitions.adoc
00bef83 
fixing formatting errors
@sarma1807
Update table-column-definitions.adoc
ca08b8f 
fixing formatting errors
@sarma1807
Update table-properties.adoc
ce54197 
fixing formatting errors
@sarma1807
Update create-index.adoc
464dff7 
fixing formatting errors
@sarma1807
Update create-table-examples.adoc
0441059 
fixing formatting issues
@sarma1807
Update security.adoc
7a44660 
fixing formatting errors
@sarma1807
Update security.adoc
c7b4ab5 
fixing formatting errors
@sarma1807
Update SASI.adoc
35a0472 
fixing formatting errors
@sarma1807
Update SASI.adoc
bc5af7d 
fixing formatting errors
@sarma1807
Update SASI.adoc
3934863 
fixing formatting errors
@sarma1807
Update SASI.adoc
b456af8 
fixing formatting errors
@sarma1807
Update SASI.adoc
45dc3e0 
fixing formatting errors
@sarma1807
Update SASI.adoc
91a1ca0 
fixing formatting errors
@sarma1807
Update SASI.adoc
8640e0c 
fixing formatting errors
@sarma1807
Update SASI.adoc
3ac6bba 
fixing formatting errors
@sarma1807
Update SASI.adoc
920f8f3 
fixing formatting errors
@sarma1807
Copy link
Contributor Author

Jira : https://issues.apache.org/jira/browse/CASSANDRA-20170

bbotella
bbotella reviewed Dec 27, 2024
View reviewed changes
Copy link
Contributor

@bbotella bbotella left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Thanks a lot for the docs improvements! Just some small comments.

doc/modules/cassandra/pages/developing/cql/SASI.adoc
@@ -9,7 +9,7 @@ has superior performance in cases where queries would previously require
filtering. In achieving this performance, SASI aims to be significantly
less resource intensive than existing implementations, in memory, disk,
and CPU usage. In addition, SASI supports prefix and contains queries on
strings (similar to SQL's `LIKE = "foo*"` or `LIKE = "*foo*"'`).
strings (similar to SQL's ``LIKE = "foo\*"`` or ``LIKE = "*foo*"`` ).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weirdly enough, my IntelliJ renderer is rendering the ` (single) and the ` `(double) are rendered the same. Is that expected? If that's the case, we should keep consistency (at line 4, I can see the word Index wrapped by a single `

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SASI_1

fix renders properly after antora build

doc/modules/cassandra/pages/developing/cql/SASI.adoc
@@ -405,15 +405,15 @@ or more page-sized blocks. The
https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/index/sasi/disk/OnDiskIndex.java[`OnDiskIndex`]
is structured as a tree of arrays, where each level describes the terms
in the level below, the final level being the terms themselves. The
`PointerLevel`s and their `PointerBlock`s contain terms and pointers to
``PointerLevel``s and their ``PointerBlock``s contain terms and pointers to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is leaving the `s out of the highlight.
Captura de pantalla 2024-12-27 a la(s) 8 22 10 a m

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SASI_2

fix renders properly after antora build

doc/modules/cassandra/pages/developing/cql/SASI.adoc
@@ -519,7 +519,7 @@ execution.

During the analysis phase,
https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/index/sasi/plan/QueryPlan.java[`QueryPlan`]
converts from Cassandra's internal representation of `IndexExpression`s,
converts from Cassandra's internal representation of ``IndexExpression``s,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for this one. Please check all around.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SASI_3

fix renders properly after antora build

@michaelsembwever
Copy link
Member

michaelsembwever commented Dec 30, 2024 •
edited
Loading

Has the generated output been checked ?
i.e. from

git clone https://github.com/apache/cassandra-website.git
cd cassandra-website
./run.sh  website build -g -u cassandra:https://github.com/sarma1807/cassandra.git -b cassandra:docs_fixes_20241206

( the static generated website is then found under content/ )

How intellij renders the adoc files is not always how our antora setup does.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bbotella bbotella bbotella left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sarma1807 @michaelsembwever @bbotella