Documentation overhaul

Registered by Baron Schwartz on 2012-02-03

The docs need an overall refresh and update to make them professional and well written, and to bring them into the modern age; some were written in the mysql 5.0 days, it seems.

1. Remove the LICENSE stuff from the HTML docs; it doesn't need to be repeated. Add a LICENSE HTML doc page.

2. Change code blocks to SQL highlighting if the first word is all-uppercase.

3. Add custom CSS for <blockquote> elements, such as those in pt-deadlock-logger's HTML docs.

4. Don't make |MySQL| a special word.

5. Don't global search-replace the toolname with ref links; see the code block in --sample in pt-query-digest's documentation.

6. Why do some tools, like pt-mext, look like the cmdline options are a table?

7. The configuration_files.html formatting is ugly.

8. Remove code blocks that are just serving as lazy man's bullet lists.

Blueprint information

Status:
Complete
Approver:
None
Priority:
Medium
Drafter:
None
Direction:
Approved
Assignee:
None
Definition:
Obsolete
Series goal:
None
Implementation:
Unknown
Milestone target:
None
Completed by
Daniel Nichter

Related branches

Sprints

Whiteboard

Baron has a local branch with a lot of improvements on this point. But it is too risky to release without a full set of testing.

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.