Bug #83137 critique of 8.0 partition documentation
Submitted: 24 Sep 2016 22:37 Modified: 25 Sep 2016 12:37
Reporter: Rick James Email Updates:
Status: Verified Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:8.0 OS:Any
Assigned to: Jon Stephens CPU Architecture:Any
Tags: documentation, partition

[24 Sep 2016 22:37] Rick James
Description:
Critique of 8.0 documentation on Partitioning

This is in response to http://forums.mysql.com/read.php?106,647595,650604
and is aimed at Jon Stephens and Dan Price.

-- Background.
I am reviewing 8.0 docs on partitioning with two things in mind:
* As a Technical editor - looking for ways to improve the phrasing, etc.;
* As a frequent Forum answerer - A common question (though not phrased this way) is "why is partitioning not solving my performance problems".  Of necessity, the docs are a "reference manual".  However, I encourage the inclusion of tidbits of info that border on "best practice".

-- Overall impressions

The overall structure, inter-page links, etc, seems to be adequate.  PARTITIONing is spread across a lot of pages, but there is a lot of information to present.

The information, explanations, and other verbiage is reasonably good.  (And have probably been incrementally improved since partitioning was introduced.)  The examples are somewhat "non-real-world", but the message seems to need such.  There are a few things that have not yet been updated for 8.0 -- especially MyISAM references (except for saying 'not supported').

I'm worried that "native partitions" has more impact than is visible in the pages.  Alas, I am not an expert on that new feature, so I can't be more specific.

-- Specific comments, by page...

(To be attached - due to length restrictions in this UI.)

How to repeat:
N/A

Suggested fix:
Included in Description and Attachment
[24 Sep 2016 22:39] Rick James
continuation

Attachment: partition80.txt (text/plain), 9.32 KiB.

[25 Sep 2016 12:37] Umesh Shastry
Hello Rick,

Thank you for the report and feedback!

Thanks,
Umesh
[26 Sep 2016 9:58] Jon Stephens
Thanks, Rick. Haven't looked at the comment text yet, but be assured that we will. :)