You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by "Anthony Grasso (JIRA)" <ji...@apache.org> on 2019/01/09 01:29:00 UTC
[jira] [Commented] (CASSANDRA-14971) Website documentation search
function returns broken links
[ https://issues.apache.org/jira/browse/CASSANDRA-14971?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16737725#comment-16737725 ]
Anthony Grasso commented on CASSANDRA-14971:
--------------------------------------------
It looks like the search results are pieced together by the [searchtools.js|https://svn.apache.org/repos/asf/cassandra/site/src/js/searchtools.js] file that lives in the _js_ directory in the SVN [repository|https://svn.apache.org/repos/asf/cassandra/site]. Specifically the {{displayNextItem()}} function walks through the returned results and generates the HTML output. This function generates the filenames using the data in the returned results.
The search results are generated by the {{performObjectSearch}} and {{performTermsSearch}} functions. These functions obtain the file information from the search index. In this case, it is the search index file ([searchindex.js|https://svn.apache.org/repos/asf/cassandra/site/src/doc/4.0/searchindex.js] which is generated by Sphinx.
It appears that we are referencing the documents in the {{filenames}} list property of the search index. These documents contain the *.rst* extension. We should probably be referencing the documents in the {{docnames}} list property of the search index.
> Website documentation search function returns broken links
> -----------------------------------------------------------
>
> Key: CASSANDRA-14971
> URL: https://issues.apache.org/jira/browse/CASSANDRA-14971
> Project: Cassandra
> Issue Type: Bug
> Components: Documentation/Website
> Reporter: Anthony Grasso
> Assignee: Anthony Grasso
> Priority: Major
>
> The search bar on the main page of the [Cassandra Documentation|http://cassandra.apache.org/doc/latest/] returns search [results|http://cassandra.apache.org/doc/latest/search.html?q=cache&check_keywords=yes&area=default] with broken links.
> When a link from a returned search is clicked, the site returns a 404 with the message similar to this:
> {quote}The requested URL /doc/latest/tools/nodetool/nodetool.rst.html was not found on this server.
> {quote}
> From the error, it appears that the links are pointing to pages that end in *.rst.html* in their name. The links should point to pages that end in *.html*.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org