Bug #57424 Change history is not included in the Cluster docs
Submitted: 13 Oct 2010 7:52 Modified: 24 Jan 2014 16:28
Reporter: Andrew Morgan Email Updates:
Status: Won't fix Impact on me:
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:MySQL Cluster 7.1.8 OS:Any
Assigned to: Jon Stephens CPU Architecture:Any

[13 Oct 2010 7:52] Andrew Morgan
The MySQL Cluster change history is included in the MySQL 5.1 documentation: http://dev.mysql.com/doc/refman/5.1/en/mysql-cluster-news-7-1.html but it is not included in the Cluster exerpt (neither the html nor PDF versions).

How to repeat:
Check cluster docs at http://dev.mysql.com/doc/index-cluster.html

Suggested fix:
Include the chapter in the Cluster docs.
[13 Oct 2010 8:32] Jon Stephens
The Cluster Excerpt is an *excerpt* of the Cluster documentation, it's not a complete copy of it, nor is it intended to be.

IMO the excerpt should be download-only in any case. I've never understood why it was put online or the perceived need to link to it or within it there, since it's completely redundant in that venue.
[13 Oct 2010 9:12] Andrew Morgan
I disagree on this one. When I click on "MySQL Cluster" from http://dev.mysql.com/doc/ I'm taken to http://dev.mysql.com/doc/index-cluster.html - all good so far. Now that I'm on the Cluster documentation page it's reasonable for me to assume that all of the Cluster documentation is there - it isn't. I'm meant to guess that for the change history I need to leave that page and go to the MySQL Manual page for that information.

If I download the PDF of the Cluster Reference Guide then I'd like it to include all of the Cluster information. Obviously as Cluster includes MySQL Server as an API node, there will some server information that I'd need to go to the MySQL Reference Manual for but the stuff that is unique to Cluster should be in the Cluster doc.

Personally I do see value in having the Cluster-specific on-line documentation partly because it's clearly a big topic and having the root of the information be chapter 17 feels like it adds an extra level of complexity/obscurity. I also think that the section numbers in the PDF should match the on-line html ones (I often do my searches in the PDF version and then want to navigate to the on-line equivalent so that I can give someone the link).
[24 Jan 2014 16:28] Jon Stephens
Changelogs are no longer incorporated in the documentation so this is no longer an issue.