cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Evan Prothro (JIRA)" <>
Subject [jira] [Commented] (CASSANDRA-12804) CQL docs table of contents links are broken
Date Wed, 19 Oct 2016 20:51:58 GMT


Evan Prothro commented on CASSANDRA-12804:

I've looked at it further and it appears the CQL spec content in the new sphinx docs is a
good replacement for the legacy html doc (IMHO). The notable difference is that the old docs
didn't include Queries as part of DML statements, the new docs lump Queries into DML statements.
I personally prefer the former, but the difference is probably only semantic.

It would also appear that removing the legacy docs has a side effect of the build no longer
including the cql docs. Is that a problem?

A stab at that removal:

This is my first PR to Cassandra, apologies if I'm doing it wrong.

It appears that the website is manually updated on occasion. They are currently out of date
at 3.7, and the CSS has noticeable width issues.

What about the following?

1. Change directory structure for legacy cql.html files on web from

- /doc/cql3/
  - CQL-2.1.html
  - CQL-2.2.html
  - CQL-3.0.html
  - CQL.css


- /doc/cql_2_1/
  - CQL.html
  - CQL.css
- /doc/cql_2_2/
  - CQL.html
  - CQL.css
- /doc/cql_3_0/
  - CQL.html
  - CQL.css

2. Generate newest sphinx docs from 3.9 branch and push to website

* This updates to latest release doc content
* This fixes the existing formatting issues

3. Remove cql.textile, et al in 3.X branch

> CQL docs table of contents links are broken
> -------------------------------------------
>                 Key: CASSANDRA-12804
>                 URL:
>             Project: Cassandra
>          Issue Type: Bug
>          Components: Documentation and Website
>            Reporter: Evan Prothro
>            Priority: Trivial
> Example: Clicking on a link in the table of contents at
results in a 404 to
> Links in the body work.
> Table of contents link to the base file name (cql.html), but the html file is cql-[version].html)

This message was sent by Atlassian JIRA

View raw message