Milestones for Developing Documentation

Registered by marisa plumb

Documentation can serve as the bridge between the Drizzle project and new developers and users; thereby it should be a dynamic but ease-to-follow set of resources. Drizzle's documentation aims to provide starting points for Drizzle users, and well as context, expertise, and specifications for using open source database management systems.

TO DO:

Audit and analysis of current docs and wiki

Determine user vs. developer documentation and what the overlaps are
-ways in which Drizzle is described
-merge Wiki FAQ and Questions pages
-what info is essential to both users and developers
-what resources lie outside 'drizzle' pages and how can they be incorporated and/or referenced

Identify user stories for Drizzle users -- this could potentially define versions or navigation for Drizzle docs
(recruit possible users to talk to at rackspace or otherwise?)

Determine/learn to what extent Drizzle vs. mysql plays into the shape of the documentation (can the use case of merging from mysql to Drizzle be addressed by a self-contained section of the documentation)

Fill in and update external learning resources (i.e. Wikipedia)

Learn the data_dictionary/information_schema layer and how it works with other user guides/Drizzle understanding

Establish tone and writing style for the user guides

Suggest potential manual architecture for team review

Create tutorials as needed

Document how Drizzle handles replication (using Tungsten)

Create and expand documentation on installing Linux packages (http://wiki.drizzle.org/Distributions/Packaging)

Create elegant user documentation for SQL functions - learn from how MySQL and Postgres provide this documentation and provide the best of both worlds.
          o http://dev.mysql.com/doc/
          o http://www.postgresql.org/docs/9.0/interactive/index.html

Blueprint information

Status:
Not started
Approver:
None
Priority:
Undefined
Drafter:
None
Direction:
Needs approval
Assignee:
marisa plumb
Definition:
New
Series goal:
None
Implementation:
Unknown
Milestone target:
None

Sprints

Whiteboard

Work items:

compile all mentioned diffs between drizzle and mysql: INPROGRESS
get wikipedia article for Drizzle up to date: INPROGRESS
Audit and analysis of current docs and wiki: INPROGRESS
Identify user stories for Drizzle -- this could potentially define versions or navigation for Drizzle docs
(possible users to talk to at rackspace or otherwise?): INPROGRESS
edit / rewrite the content currently on docs.drizzle.org: INPROGRESS

determine missing pieces on docs.drizzles.org: TO DO
Determine user vs. developer documentation and what the overlaps are: TO DO
merge Wiki FAQ and Questions pages: TO DO
Learn the data_dictionary/information_schema layer and how it works with other user guides/Drizzle understanding: TODO
Document how Drizzle handles replication (using Tungsten): TODO
Create and expand documentation on installing Linux packages (http://wiki.drizzle.org/Distributions/Packaging): TODO
Create elegant user documentation for SQL functions - learn from how MySQL and Postgres provide this documentation and provide the best of both worlds: INPROGRESS

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.