[
https://issues.apache.org/jira/browse/CASSANDRA-20170?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Michael Semb Wever reassigned CASSANDRA-20170:
----------------------------------------------
Assignee: Sarma Pydipally
> several documentation fixes
> ---------------------------
>
> Key: CASSANDRA-20170
> URL: https://issues.apache.org/jira/browse/CASSANDRA-20170
> Project: Apache Cassandra
> Issue Type: Improvement
> Components: Documentation
> Reporter: Sarma Pydipally
> Assignee: Sarma Pydipally
> Priority: Normal
>
> several documentation fixes
> --------------------------------------
> fix 01 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/examples/CQL/vector-search/vector-search-cycling.cql
> line 25 : wrong : ADD comment_vector VECTOR <FLOAT, 5>; <1>
> line 25 : fixed : ADD comment_vector VECTOR <FLOAT, 5> ;
> --------------------------------------
> fix 02 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/data-modeling/data-modeling_conceptual.adoc
> line 33 : wrong : image::data-modeling_hotel_erd.png[image]
> line 33 : fixed : image::data_modeling_hotel_erd.png[image]
> --------------------------------------
> fix 03 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/data-modeling/data-modeling_rdbms.adoc
> line 15 : wrong : image::data-modeling_hotel_relational.png[image]
> line 15 : fixed : image::data_modeling_hotel_relational.png[image]
> --------------------------------------
> fix 04 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/data-modeling/data-modeling_queries.adoc
> line 56 : wrong :
> image::cassandra:developing/data-modeling/data-modeling_hotel_queries.png[image]
> line 56 : fixed :
> image::cassandra:developing/data-modeling/data_modeling_hotel_queries.png[image]
> --------------------------------------
> fix 05 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/data-modeling/data-modeling_logical.adoc
> line 37 : wrong :
> image::cassandra:developing/data-modeling/data-modeling_chebotko_logical.png[image]
> line 37 : fixed :
> image::cassandra:developing/data-modeling/data_modeling_chebotko_logical.png[image]
> line 54 : wrong :
> image::cassandra:developing/data-modeling/data-modeling_hotel_logical.png[image]
> line 54 : fixed :
> image::cassandra:developing/data-modeling/data_modeling_hotel_logical.png[image]
> line 130 : wrong :
> image::cassandra:developing/data-modeling/data-modeling_reservation_logical.png[image]
> line 130 : fixed :
> image::cassandra:developing/data-modeling/data_modeling_reservation_logical.png[image]
> --------------------------------------
> fix 06 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/data-modeling/data-modeling_physical.adoc
> line 22 : wrong :
> image::cassandra:developing/data-modeling/data-modeling_chebotko_physical.png[image]
> line 22 : fixed :
> image::cassandra:developing/data-modeling/data_modeling_chebotko_physical.png[image]
> line 64 : wrong :
> image::cassandra:developing/data-modeling/data-modeling_hotel_physical.png[image]
> line 64 : fixed :
> image::cassandra:developing/data-modeling/data_modeling_hotel_physical.png[image]
> line 89 : wrong :
> image::cassandra:developing/data-modeling/data-modeling_reservation_physical.png[image]
> line 89 : fixed :
> image::cassandra:developing/data-modeling/data_modeling_reservation_physical.png[image]
> --------------------------------------
> fix 07 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/data-modeling/data-modeling_refining.adoc
> line 191 : wrong : image::data-modeling_hotel_bucketing.png[image]
> line 191 : fixed : image::data_modeling_hotel_bucketing.png[image]
> --------------------------------------
> fix 08 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/cql/ddl.adoc
> line 177 : include::cassandra:example$CQL/create_ks_trans_repl.cql[]
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/examples/CQL/create_ks_trans_repl.cql
> line 2 : wrong : WITH replication = \{'class': 'NetworkTopologyStrategy',
> 'DC1' : '3/1'', 'DC2' : '5/2'};
> line 2 : fixed : WITH replication = \{'class': 'NetworkTopologyStrategy',
> 'DC1' : '3/1', 'DC2' : '5/2'};
> --------------------------------------
> fix 09 : need to verify after build
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/cql/ddl.adoc
> line 286 : wrong : partition (having the same
> xref:cassandra:developing/cql/ddl.adoc#partition-key[partition key].
> line 286 : fixed : partition (having the same
> xref:cassandra:developing/cql/ddl.adoc#partition-key[partition key]).
> --------------------------------------
> fix 10 :
> https://cassandra.apache.org/doc/latest/cassandra/developing/cql/indexing/2i/2i-working-with.html#check-secondary-index-2i-existence
> check Result tab :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/examples/RESULTS/2i/2i-check.result
> currently this document contains only one word : "TBD"
> add following content in this file :
> CREATE TABLE cycling.birthday_list (
> cyclist_name text PRIMARY KEY,
> .
> .
> .
> CREATE INDEX blist_values_idx ON cycling.birthday_list (values(blist));
> --------------------------------------
> fix 11 : need to verify after build
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/cql/mvs.adoc
> line 76 : wrong :
> xref:cassandra:developing/cql/dml.adoc#allow-filtering[ALLOW FILTERING
> line 76 : fixed :
> xref:cassandra:developing/cql/dml.adoc#allow-filtering[ALLOW FILTERING]
> line 155 : wrong : fixed on CASSANDRA-13826.
> line 155 : fixed : fixed on
> https://issues.apache.org/jira/browse/CASSANDRA-13826[CASSANDRA-13826].
> --------------------------------------
> fix 12 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/cql/functions.adoc
> line 304 : wrong : already in progress. For more information -
> CASSANDRA-17281, CASSANDRA-18252.
> line 304 : fixed : already in progress. For more information -
> https://issues.apache.org/jira/browse/CASSANDRA-17281[CASSANDRA-17281],
> https://issues.apache.org/jira/browse/CASSANDRA-18252[CASSANDRA-18252].
> --------------------------------------
> fix 13 : need to verify after build
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/cql/security.adoc
> line 174 : wrong : xref:security.adoc#grant-role-statement[roles]` granted to
> it, any client sessions still
> line 174 : fixed : xref:security.adoc#grant-role-statement[roles] granted to
> it, any client sessions still
> line 347 : wrong : Note that this statement is equivalent to
> xref:security.adoc#list-roles-statement[`LIST ROLES], but only roles with the
> `LOGIN` privilege are included in the output.
> line 347 : fixed : Note that this statement is equivalent to
> xref:security.adoc#list-roles-statement[LIST ROLES], but only roles with the
> `LOGIN` privilege are included in the output.
> line 663 : wrong : Show any permissions granted to `carlos` or any of
> `carlos`'s roles,
> line 663 : fixed : Show any permissions granted to `carlos` or any roles
> assigned to `carlos`,
> --------------------------------------
> fix 14 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/examples/CQL/no_revoke.cql
> wrong :
> * `system_schema.keyspaces`
> * `system_schema.columns`
> ` symbols do NOT add any value
> fixed :
> * system_schema.keyspaces
> * system_schema.columns
> * system_schema.tables
> * system.local
> * system.peers
> --------------------------------------
> fix 15 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/cql/changes.adoc
> enhancement proposal :
> line 1 : current : = Changes
> line 1 : enhanced : = CQL Changes
> looks like this document contains a lot of jira ticket numbers but not linked
> to them. will it be helpful to link all numbers to their respective jira ?
> line 66 : wrong :
> https://issues.apache.org/jira/browse/CASSANDRA-7017)[CASSANDRA-7017].
> line 66 : fixed :
> https://issues.apache.org/jira/browse/CASSANDRA-7017[CASSANDRA-7017]).
> line 70 : wrong :
> https://issues.apache.org/jira/browse/CASSANDRA-10818)[CASSANDRA-10818].
> line 70 : fixed :
> https://issues.apache.org/jira/browse/CASSANDRA-10818[CASSANDRA-10818]).
> line 74 : wrong :
> (https://issues.apache.org/jira/browse/CASSANDRA-7423)[CASSANDRA-7423]).
> line 74 : fixed :
> (https://issues.apache.org/jira/browse/CASSANDRA-7423[CASSANDRA-7423]).
> line 178 : wrong :
> https://issues.apache.org/jira/browse/CASSANDRA-5626)[CASSANDRA-5626].
> line 178 : fixed :
> https://issues.apache.org/jira/browse/CASSANDRA-5626[CASSANDRA-5626]).
> --------------------------------------
> fix 16 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/cql/SASI.adoc
> line 1 : current : == SASI Index
> line 1 : enhanced : = SASI Index
> line 12 : wrong : strings (similar to SQL's `LIKE = "foo*"` or `LIKE =
> "*foo*"'`).
> line 12 : fixed : strings (similar to SQL's ``LIKE = "foo\*"`` or ``LIKE =
> "*foo*"`` ).
> line 360 : wrong : is the origin of the name ``SSTable Attached Secondary
> Index''.
> line 360 : fixed : is the origin of the name `SSTable Attached Secondary
> Index`.
> line 408 : wrong : `PointerLevel`s and their `PointerBlock`s contain terms
> and pointers to
> line 408 : fixed : ``PointerLevel``s and their ``PointerBlock``s contain
> terms and pointers to
> line 410 : wrong : level, and its `DataBlock`s contain terms and point to the
> data itself,
> line 410 : fixed : level, and its ``DataBlock``s contain terms and point to
> the data itself,
> line 416 : wrong : vary depending on its ``mode'': either `PREFIX`,
> `CONTAINS`, or
> line 416 : fixed : vary depending on its `mode` : either `PREFIX`,
> `CONTAINS`, or
> line 431 : wrong : ``mode'' is configurable per column at index creation time.
> line 431 : fixed : `mode` is configurable per column at index creation time.
> line 438 : wrong : https://en.wikipedia.org/wiki/B%2B_tree[B+-tree] that has
> been modified
> line 438 : fixed : https://en.wikipedia.org/wiki/B%2B_tree[B+ tree] that has
> been modified
> line 522 : wrong : converts from Cassandra's internal representation of
> `IndexExpression`s,
> line 522 : fixed : converts from Cassandra's internal representation of
> ``IndexExpression``s,
> line 656 : wrong : `AND`s the `age` expressions can be collapsed. Along with
> this
> line 656 : fixed : ``AND``s the `age` expressions can be collapsed. Along
> with this
> line 657 : wrong : optimization, the initial collapsing of unneeded `AND`s
> can also be
> line 657 : fixed : optimization, the initial collapsing of unneeded ``AND``s
> can also be
> line 686 : wrong : ``Range(Union|Intersection)Iterator'' section, implement
> the necessary
> line 686 : fixed : `Range(Union|Intersection)Iterator` section, implement the
> necessary
> line 709 : wrong : iterated, or ``streaming'', fashion to prevent unneeded
> reads of
> line 709 : fixed : iterated, or `streaming`, fashion to prevent unneeded
> reads of
> line 716 : wrong : performs the ``Merge-Join'' portion of the
> line 716 : fixed : performs the `Merge-Join` portion of the
> line 736 : wrong : in that it performs a ``Merge-Join'', however, its nature
> is similar to
> line 736 : fixed : in that it performs a `Merge-Join`, however, its nature is
> similar to
> line 745 : wrong : structure, or ``hash lookup'' in database terminology.
> Once again,
> line 745 : fixed : structure, or `hash lookup` in database terminology. Once
> again,
> line 797 : wrong : `LongToken`s, e.g. `Murmur3Partitioner`. Other existing
> partitioners
> line 797 : fixed : ``LongToken``s, e.g. `Murmur3Partitioner`. Other existing
> partitioners
> --------------------------------------
> fix 17 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/developing/cql/cql_singlefile.adoc
> line 3 : \\{toc:maxLevel=3}
> problem : is not properly rendered
> replace above with following 2 lines :
> :toc:
> :toclevels: 3
> --------------------------------------
> fix 18 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/vector-search/data-modeling.adoc
> enhancement proposal :
> line 1 : current : = Data Modeling
> line 1 : enhanced : = Vector Search : Data Modeling
> --------------------------------------
> fix 19 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/managing/configuration/cass_jvm_options_file.adoc
> line 17 : wrong : The `jvm-*` files replace the `cassandra-envsh` file used
> in Cassandra
> line 17 : fixed : The `jvm-\*` files replace the `cassandra-env.sh` file used
> in Cassandra
> NOT A BUG : line 20 : wrong : system settings. The `jvm-*` files only store
> static JVM settings.
> NOT A BUG : line 20 : fixed : system settings. The `jvm-\*` files only store
> static JVM settings.
> --------------------------------------
> fix 20 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/managing/operating/cdc.adoc
> enhancement proposal :
> line 90 : current : *
> https://issues.apache.org/jira/browse/CASSANDRA-8844[JIRA ticket]
> line 90 : enhanced : * Change Data Capture (
> https://issues.apache.org/jira/browse/CASSANDRA-8844[CASSANDRA-8844 JIRA
> ticket] )
> line 91 : current : *
> https://issues.apache.org/jira/browse/CASSANDRA-12148[JIRA ticket]
> line 91 : enhanced : * Improve determinism of CDC data availability (
> https://issues.apache.org/jira/browse/CASSANDRA-12148[CASSANDRA-12148 JIRA
> ticket] )
> --------------------------------------
> fix 21 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/managing/operating/compaction/tombstones.adoc
> line 38 : wrong : The grace period for a tombstone is set with the table
> property ` WITH gc_grace_seconds`.
> line 38 : fixed : The grace period for a tombstone is set with the table
> property `WITH gc_grace_seconds`.
> --------------------------------------
> fix 22 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/managing/operating/topo_changes.adoc
> line 100 : current : node that is being replaced. (See CASSANDRA-8523 and
> CASSANDRA-12344)
> line 100 : enhanced : node that is being replaced. ( See
> https://issues.apache.org/jira/browse/CASSANDRA-8523[CASSANDRA-8523] and
> https://issues.apache.org/jira/browse/CASSANDRA-12344[CASSANDRA-12344] )
> --------------------------------------
> fix 23 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/managing/tools/sstable/sstableverify.adoc
> line 12 : current : See CASSANDRA-9947 and CASSANDRA-17017 for discussion ...
> line 12 : enhanced : See
> https://issues.apache.org/jira/browse/CASSANDRA-9947[CASSANDRA-9947] and
> https://issues.apache.org/jira/browse/CASSANDRA-17017[CASSANDRA-17017] for
> discussion ...
> line 26 : current : |-f, --force |allow use of tool (see CASSANDRA-17017 for
> risks)
> line 26 : enhanced : |-f, --force |allow use of tool (see
> https://issues.apache.org/jira/browse/CASSANDRA-17017[CASSANDRA-17017] for
> risks)
> --------------------------------------
> fix 24 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/troubleshooting/use_tools.adoc
> line 21 : current : prevent long pauses (see `CASSANDRA-9242` and
> `CASSANDRA-9483` for
> line 21 : enhanced : prevent long pauses (see
> https://issues.apache.org/jira/browse/CASSANDRA-9242[CASSANDRA-9242] and
> https://issues.apache.org/jira/browse/CASSANDRA-9483[CASSANDRA-9483] for
> line 24 : current : `CASSANDRA-9242`.
> line 24 : enhanced :
> https://issues.apache.org/jira/browse/CASSANDRA-9242[CASSANDRA-9242] .
> --------------------------------------
> fix 25 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/reference/static.adoc
> line 5 : wrong : In a table that uses
> https://cassandra.apache.org/_/glossary.html#clustering-column[clustering
> columns], non-clustering columns can be declared static in the table
> definition.
> line 5 : fixed : In a table that uses
> https://cassandra.apache.org/\_/glossary.html#clustering-column[clustering
> columns], non-clustering columns can be declared static in the table
> definition.
> NOT A BUG : line 6 : wrong :
> https://cassandra.apache.org/_/glossary.html#static-column[Static columns]
> are only static within a given partition.
> NOT A BUG : line 6 : fixed :
> https://cassandra.apache.org/\_/glossary.html#static-column[Static columns]
> are only static within a given partition.
> --------------------------------------
> fix 26 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/reference/cql-commands/alter-table.adoc
> line 40 : include::cassandra:partial$cql-syntax-legend.adoc[]
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/partials/cql-syntax-legend.adoc
> line 44 : wrong : | `<<datatype1>,<datatype2>>`
> line 44 : fixed : | `< <datatype1>,<datatype2> >`
> --------------------------------------
> fix 27 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/reference/cql-commands/alter-table.adoc
> line 53 : include::cassandra:partial$table-column-definitions.adoc[]
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/partials/table-column-definitions.adoc
> line 11 : wrong : ... and is defined as the
> https://cassandra.apache.org/_/glossary.html#[partition-key][partition key].
> line 11 : fixed : ... and is defined as the
> https://cassandra.apache.org/_/glossary.html#partition-key[partition key].
> --------------------------------------
> fix 28 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/reference/cql-commands/alter-table.adoc
> line 85 : include::cassandra:partial$table-properties.adoc[]
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/partials/table-properties.adoc
> line 93 : wrong : ... only data with
> https://cassandra.apache.org/_/glossary.html#gloss_ttl[TTL] set, or ...
> line 93 : fixed : ... only data with
> https://cassandra.apache.org/_/glossary.html#ttl[TTL] set, or ...
> line 130 : wrong : ... to satisfy the
> https://cassandra.apache.org/_/glossary.html#gloss_consistency_level[consistency
> level].
> line 130 : fixed : ... to satisfy the
> https://cassandra.apache.org/_/glossary.html#consistency-level[consistency
> level].
> --------------------------------------
> fix 29 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/reference/cql-commands/create-index.adoc
> line 243 : wrong : Assume a cyclist table contains this map data where
> `nation is the map key and `Canada` is the map value`:
> line 243 : fixed : Assume a cyclist table contains this map data where
> `nation` is the map key and `Canada` is the map value:
> --------------------------------------
> fix 30 :
> https://github.com/apache/cassandra/blob/cassandra-5.0/doc/modules/cassandra/pages/reference/cql-commands/create-table-examples.adoc
> line 68 : wrong : See
> https://docs.datastax.com/en/dse/6.8/dse-admin/datastax_enterprise/config/configCassandra_yaml.html#configCassandra_yaml__cdcSpaceSection[Change-data-capture
> (CDC) space settings] for information about available CDC settings.
> line 68 : fixed : See
> https://docs.datastax.com/en/dse/6.8/dse-admin/datastax_enterprise/config/configCassandra_yaml.html#cdcSpaceSection[Change-data-capture
> (CDC) space settings] for information about available CDC settings.
> --------------------------------------
--
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
