[
https://issues.apache.org/jira/browse/CASSANDRA-20656?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Alvin Zhang updated CASSANDRA-20656:
------------------------------------
Description:
5.0 documentation shows two sections for `column_definition` (see
[here|https://cassandra.apache.org/doc/5.0/cassandra/reference/cql-commands/create-table.html#column_definition])
The
`[create-table.adoc|https://github.com/apache/cassandra/blob/trunk/doc/modules/cassandra/pages/reference/c%20ql-commands/create-table.adoc?plain=1#L56]`
references two nearly identical partials:
* cassandra:partial$table-column-definitions.adoc
* cassandra:partial$primary-key-column.adoc
```
```
diff doc/modules/cassandra/partials/table-column-definitions.adoc
doc/modules/cassandra/partials/primary-key-column.adoc
11c11
< * When `PRIMARY KEY` is at the end of a column definition, that column is the
only primary key for the table, and is defined as the
[https://cassandra.apache.org/_/glossary.html#partition-key[partition] key].
—
> * When `PRIMARY KEY` is at the end of a column definition, that column is the
> only primary key for the table, and is defined as the
> [https://cassandra.apache.org/_/glossary.html#[partition-key][partition] key].
```
I propose removing `primary-key-column.adoc` and its reference in
`create-table.adoc`
was:
5.0 documentation shows two sections for `column_definition` (see
[here|https://cassandra.apache.org/doc/5.0/cassandra/reference/cql-commands/create-table.html#column_definition])
The
`[create-table.adoc|https://github.com/apache/cassandra/blob/trunk/doc/modules/cassandra/pages/reference/c
ql-commands/create-table.adoc?plain=1#L56]` references two partials:
* cassandra:partial$table-column-definitions.adoc
* cassandra:partial$primary-key-column.adoc
which are nearly identical
```
diff doc/modules/cassandra/partials/table-column-definitions.adoc
doc/modules/cassandra/partials/primary-key-column.adoc
11c11
< * When `PRIMARY KEY` is at the end of a column definition, that column is the
only primary key for the table, and is defined as the
https://cassandra.apache.org/_/glossary.html#partition-key[partition key].
---
> * When `PRIMARY KEY` is at the end of a column definition, that column is the
> only primary key for the table, and is defined as the
> https://cassandra.apache.org/_/glossary.html#[partition-key][partition key].
```
I propose removing `primary-key-column.adoc` and its reference in
`create-table.adoc`
> Create table documentation uses two nearly-identical partials for column
> definition
> -----------------------------------------------------------------------------------
>
> Key: CASSANDRA-20656
> URL: https://issues.apache.org/jira/browse/CASSANDRA-20656
> Project: Apache Cassandra
> Issue Type: Improvement
> Components: Documentation
> Reporter: Alvin Zhang
> Assignee: Alvin Zhang
> Priority: Normal
>
> 5.0 documentation shows two sections for `column_definition` (see
> [here|https://cassandra.apache.org/doc/5.0/cassandra/reference/cql-commands/create-table.html#column_definition])
> The
> `[create-table.adoc|https://github.com/apache/cassandra/blob/trunk/doc/modules/cassandra/pages/reference/c%20ql-commands/create-table.adoc?plain=1#L56]`
> references two nearly identical partials:
> * cassandra:partial$table-column-definitions.adoc
> * cassandra:partial$primary-key-column.adoc
> ```
> ```
> diff doc/modules/cassandra/partials/table-column-definitions.adoc
> doc/modules/cassandra/partials/primary-key-column.adoc
> 11c11
> < * When `PRIMARY KEY` is at the end of a column definition, that column is
> the only primary key for the table, and is defined as the
> [https://cassandra.apache.org/_/glossary.html#partition-key[partition] key].
> —
> > * When `PRIMARY KEY` is at the end of a column definition, that column is
> > the only primary key for the table, and is defined as the
> > [https://cassandra.apache.org/_/glossary.html#[partition-key][partition]
> > key].
> ```
> I propose removing `primary-key-column.adoc` and its reference in
> `create-table.adoc`
--
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
