A Lightweight SQL Database for Cloud Infrastructure and Web Applications

Docs day first pass fixes

Reported by Andrew Hutchings on 2011-02-23
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Drizzle
Medium
Stewart Smith
7.0
Medium
Unassigned

Bug Description

List of things for me to fix after first pass on docs day:

http://docs.drizzle.org/mysql_differences.html
* Partitioning section empty
* Command line clients "There is no Drizzle admin command." - there is but it is not the same as mysqladmin

http://docs.drizzle.org/installing/ubuntu.html
* "sudo apt-get install drizzle-server drizzle-client" should be "sudo apt-get install drizzle drizzle-client"

http://docs.drizzle.org/orderby.html
* 2 TODOs

http://docs.drizzle.org/join.html
* Note using wrong markup
* Need sub-pages to show each join

http://docs.drizzle.org/functions/logical.html
* Not using SQL markup

http://docs.drizzle.org/functions/mathematical.html
* Result for cube root alignment

http://docs.drizzle.org/functions/current_time_functions.html
* Not using SQL markup
* now() incorrect about microtime

http://docs.drizzle.org/functions/extract_date_functions.html
* headings using wrong markup

http://docs.drizzle.org/functions/date_trunc.html
* Empty topic

http://docs.drizzle.org/functions/aggregatefunctions.html
* Question should use TODO markup and needs answering

http://docs.drizzle.org/functions/control_flow.html
* Numbering markup could probably be better
* SELECT, WHERE, etc.. should use `` markup
* Need examples for IF/ELSE, etc...

http://docs.drizzle.org/functions/string/comparative.html
* Not using SQL markup
* Broken markup for "Other REGEXP examples"

http://docs.drizzle.org/functions/string/conversion.html
* Not using SQL markup

http://docs.drizzle.org/functions/string/length.html
* Source contains encoding errors
* Not using SQL markup

http://docs.drizzle.org/functions/string/modification.html
* Not using SQL markup
* CONCAT_WS examples not using any markup
* TRIM, LTRIM, RTRIM needs examples

http://docs.drizzle.org/functions/string/position.html
* Not using SQL markup
* Need examples for most topics

http://docs.drizzle.org/functions/string/other.html
* Not using SQL markup

http://docs.drizzle.org/numeric_data_types.html
* Needs to use `` markup

http://docs.drizzle.org/date_time_data_types.html
* TIME needs to link to the migration section of drizzledump

http://docs.drizzle.org/string_data_types.html
* TODO using wrong markup, plus needs fixing

http://docs.drizzle.org/boolean_data_type.html
* Needs `` markup

http://docs.drizzle.org/uuid_data_type.html
* Links to RFC, ISO possible?

http://docs.drizzle.org/alter_table.html
* Syntax and examples needed
* TODO to fix

http://docs.drizzle.org/create_table.html
* Probably a better way to do the markup

http://docs.drizzle.org/drop_table.html
* Not using SQL markup

http://docs.drizzle.org/truncate.html
* Fix TODO

http://docs.drizzle.org/rename.html
* Possibly slightly more body
* See also markup needed

http://docs.drizzle.org/create_schema.html
* Some body
* markup

http://docs.drizzle.org/create_index.html
* Not using SQL markup
* markup on the first line

http://docs.drizzle.org/drop_index.html
* Not using SQL markup

http://docs.drizzle.org/dml.html
* Fix TODO

http://docs.drizzle.org/delete.html
* Not using SQL markup

http://docs.drizzle.org/insert.html
* Fix TODO
* markup fixes

http://docs.drizzle.org/columntypes.html
* Temporal internal links and possibly one-liners

http://docs.drizzle.org/variables.html
* markup

http://docs.drizzle.org/locks.html
* markup
* Fix TODO

http://docs.drizzle.org/barriers.html
* markup

http://docs.drizzle.org/dynamic.html
* Fix TODO

http://docs.drizzle.org/data_dictionary.html
* Fix TODO

http://docs.drizzle.org/information_schema.html
* Description of each table

http://docs.drizzle.org/show.html
* Missing content

http://docs.drizzle.org/describe.html
* Example

http://docs.drizzle.org/transactional.html
* Not using SQL markup

http://docs.drizzle.org/start_transaction.html
* Not using SQL markup

http://docs.drizzle.org/commit.html
* Not using SQL markup

http://docs.drizzle.org/flush.html
* markup

http://docs.drizzle.org/analyze.html
* Not using SQL markup

http://docs.drizzle.org/resources/ascii_chart.html
* ASCII 7C broken (should be '|'), possibly use `` markup?

http://docs.drizzle.org/storage_engines.html
* At least list the engines used in Drizzle with features or internal links?

http://docs.drizzle.org/configuration.html
* Should use INI markup

http://docs.drizzle.org/options.html
* Options long/short backwards and not working correctly

http://docs.drizzle.org/plugins/haildb/index.html
* Not using SQL markup

http://docs.drizzle.org/plugins/innobase/index.html
* Not using SQL markup

http://docs.drizzle.org/plugins/mysql_protocol/index.html
* Not using option markup

http://docs.drizzle.org/plugins/transaction_log/index.html
* Not using option markup

http://docs.drizzle.org/clients/drizzle.html
* Needs body
* Needs man page

http://docs.drizzle.org/clients/drizzledump.html
* Lots of my work missing, need to find out why

http://docs.drizzle.org/clients/drizzleadmin.html
* Link to drizzle command client

Other notes:
* Our table CSS needs some left padding

Andrew Hutchings (linuxjedi) wrote :

This is what I haven't fixed yet:

http://docs.drizzle.org/mysql_differences.html
* Partitioning section empty
* Command line clients "There is no Drizzle admin command." - there is but it is not the same as mysqladmin

http://docs.drizzle.org/orderby.html
* 2 TODOs

http://docs.drizzle.org/join.html
* Need sub-pages to show each join

http://docs.drizzle.org/functions/current_time_functions.html
* now() incorrect about microtime

http://docs.drizzle.org/functions/date_trunc.html
* Empty topic

http://docs.drizzle.org/functions/control_flow.html
* Need examples for IF/ELSE, etc...

http://docs.drizzle.org/functions/string/modification.html
* TRIM, LTRIM, RTRIM needs examples

http://docs.drizzle.org/functions/string/position.html
* Need examples for most topics

http://docs.drizzle.org/string_data_types.html
* TODO using wrong markup, plus needs fixing

http://docs.drizzle.org/uuid_data_type.html
* Links to RFC, ISO possible?

http://docs.drizzle.org/alter_table.html
* Syntax and examples needed
* TODO to fix

http://docs.drizzle.org/truncate.html
* Fix TODO

http://docs.drizzle.org/rename.html
* Possibly slightly more body

http://docs.drizzle.org/create_schema.html
* Some body

http://docs.drizzle.org/dml.html
* Fix TODO

http://docs.drizzle.org/insert.html
* Fix TODO

http://docs.drizzle.org/columntypes.html
* Temporal internal links and possibly one-liners

http://docs.drizzle.org/locks.html
* Fix TODO

http://docs.drizzle.org/dynamic.html
* Fix TODO

http://docs.drizzle.org/data_dictionary.html
* Fix TODO

http://docs.drizzle.org/information_schema.html
* Description of each table

http://docs.drizzle.org/show.html
* Missing content

http://docs.drizzle.org/describe.html
* Example

http://docs.drizzle.org/storage_engines.html
* At least list the engines used in Drizzle with features or internal links?

http://docs.drizzle.org/plugins/mysql_protocol/index.html
* Not using option markup

http://docs.drizzle.org/plugins/transaction_log/index.html
* Not using option markup

http://docs.drizzle.org/clients/drizzle.html
* Needs body
* Needs man page

Note: we will need a new sphinx domain with slightly different regex to :option: to fix the mysql_protocol and transaction_log markup

Andrew Hutchings (linuxjedi) wrote :

I have spun-off adding a new .. option:: directive to bug #724171. After this the plugin markup can be fixed.
My stuff has all be merged so re-assigned to Marisa for the remaining stuff. Let me know if you want me to take any parts of this.

Andrew Hutchings (linuxjedi) wrote :

Update:

* plugins options markup is in merge proposal now. Monty has fixed the markup in trunk to allow this.
* RFC link done, ISO not so important

Lee Bieber (kalebral) on 2011-03-28
Changed in drizzle:
milestone: 2011-03-28 → none
Henrik Ingo (hingo) on 2011-08-08
tags: added: docs

modified the following files:

  docs/drop_table.rst
  docs/rename.rst
  docs/truncate.rst

Stewart Smith (stewart) wrote :

I'm going to commit and push a bunch of fixes for many of these issues and we can close this bug, keeping the TODO items in the docs themselves.

Changed in drizzle:
assignee: marisa plumb (marisa-plumb) → Stewart Smith (stewart)
milestone: none → 7.2.5
status: In Progress → Fix Committed
Stewart Smith (stewart) on 2013-08-13
Changed in drizzle:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers