[
https://issues.apache.org/jira/browse/CASSANDRA-17534?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17750624#comment-17750624
]
Stefan Miklosovic commented on CASSANDRA-17534:
-----------------------------------------------
all of these PRs contain same links but there are version specific links
3.11 https://cassandra.apache.org/doc/3.11/cassandra/cql/cql_singlefile.html
4.0 https://cassandra.apache.org/doc/4.0/cassandra/cql/cql_singlefile.html
4.1 https://cassandra.apache.org/doc/4.1/cassandra/cql/cql_singlefile.html
There is not version-specific link for 3.0 though. I am not completely sure
what link we should use but whatever which is not broken is better than broken.
I guess going with "latest" is just fine.
For trunk, when 5.0 is out, there will be "5.0" link. So for the current trunk
I would just use
https://cassandra.apache.org/doc/5.0/cassandra/cql/cql_singlefile.html
even it wil not work for now but it will once 5.0 is out.
> CQLSH help topic links are broken between textile and online files
> ------------------------------------------------------------------
>
> Key: CASSANDRA-17534
> URL: https://issues.apache.org/jira/browse/CASSANDRA-17534
> Project: Cassandra
> Issue Type: Bug
> Components: CQL/Interpreter
> Reporter: Brad Schoening
> Assignee: Vineet Gali
> Priority: Normal
> Fix For: 3.0.x, 3.11.x, 4.0.x, 4.1.x, 5.x
>
>
> CQLSH help topics opens a generic CQL page, not the specific topic. This
> happens when docs are not installed locally, and it tries to open the online
> version.
> The file cqlsh.py has:
> {{ # default location of local CQL.html}}
> {{ if os.path.exists(CASSANDRA_PATH + '/doc/cql3/CQL.html'):}}
> {{ ....}}
> {{ else:}}
> {{ # fallback to online version}}
> {{ CASSANDRA_CQL_HTML = CASSANDRA_CQL_HTML_FALLBACK}}
> For example,
> {{cqlsh> help truncate;}}
> opens the page:
> [https://cassandra.apache.org/doc/latest/cassandra/cql/index.html#truncateStmt]
> but there is no information about 'truncate' on that page and the anchor
> #truncateStmt doesn't exist.
> the correct page anchor is:
> [https://cassandra.apache.org/doc/latest/cassandra/cql/ddl.html#truncate-statement]
> The local file anchors appear they may be incorrect as well:
> [https://github.com/apache/cassandra/blob/trunk/doc/cql3/CQL.textile#truncate]
> To reproduce this, 'pip install cqlsh' on a machine without a Cassandra
> package install.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
