[
https://issues.apache.org/jira/browse/CASSANDRA-17569?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Erick Ramirez updated CASSANDRA-17569:
--------------------------------------
Test and Documentation Plan: Stage locally and verify that nodetool pages
are built with a title
Status: Patch Available (was: In Progress)
[~Anthony Grasso] / [~polandll], the nodetool pages don't have titles and Mick
believes this is affecting search results.
To fix it, I've edited {{gen-nodetool-docs.py}} so that instead of the nodetool
commands marked down as {{<H2>}}, I've changed them to {{<H1>}}. This is to
force them to get promoted as page titles. I've updated the following 2 lines:
{noformat}
-commandADOCContent = "== {0}\n\n==
Usage\n[source,plaintext]\n----\ninclude::example$TEXT/NODETOOL/{0}.txt[]\n----\n"
+commandADOCContent = "= {0}\n\n==
Usage\n[source,plaintext]\n----\ninclude::example$TEXT/NODETOOL/{0}.txt[]\n----\n"
{noformat}
{noformat}
- output.write("== Nodetool\n\n== Usage\n\n")
+ output.write("= Nodetool\n\n== Usage\n\n")
{noformat}
The attached patch is just for the the {{3.11}} branch since I wanted to run it
by you first. If it seems OK to you, I will patch all the other branches.
||Branch||PR||
|{{cassandra-3.11}}|[#1655|https://github.com/apache/cassandra/pull/1655]|
Please let me know either way. Cheers! 🍻
> DOC - tools/nodetool is untitled and might be affecting search results
> ----------------------------------------------------------------------
>
> Key: CASSANDRA-17569
> URL: https://issues.apache.org/jira/browse/CASSANDRA-17569
> Project: Cassandra
> Issue Type: Task
> Components: Documentation/Website
> Reporter: Erick Ramirez
> Assignee: Erick Ramirez
> Priority: Normal
> Fix For: 4.0.x, 4.1.x
>
>
> Reported by [~mck] in [ASF Slack
> #cassandra-website|https://the-asf.slack.com/archives/C01RY1LUPD5/p1650446747714449]:
> {quote}I see that the nodetool doc pages have the title {{Untitled | …}} ( i
> think this impacting search results){quote}
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org
For additional commands, e-mail: commits-h...@cassandra.apache.org
