Menu
▾
▴
SF.net SVN: matplotlib: [5408] trunk/matplotlib/doc/devel
|
From: <jd...@us...> - 2008-06-06 03:45:59
|
Revision: 5408
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5408&view=rev
Author: jdh2358
Date: 2008-06-05 20:45:57 -0700 (Thu, 05 Jun 2008)
Log Message:
-----------
added draft outline
Modified Paths:
--------------
trunk/matplotlib/doc/devel/index.rst
Added Paths:
-----------
trunk/matplotlib/doc/devel/outline.rst
Modified: trunk/matplotlib/doc/devel/index.rst
===================================================================
--- trunk/matplotlib/doc/devel/index.rst 2008-06-05 22:23:50 UTC (rev 5407)
+++ trunk/matplotlib/doc/devel/index.rst 2008-06-06 03:45:57 UTC (rev 5408)
@@ -13,4 +13,4 @@
documenting_mpl.rst
transformations.rst
add_new_projection.rst
-
+ outline.rst
Added: trunk/matplotlib/doc/devel/outline.rst
===================================================================
--- trunk/matplotlib/doc/devel/outline.rst (rev 0)
+++ trunk/matplotlib/doc/devel/outline.rst 2008-06-06 03:45:57 UTC (rev 5408)
@@ -0,0 +1,99 @@
+.. _outline:
+
+************
+Docs outline
+************
+
+Proposed chapters for the docs, who has responsibility for them, and
+who reviews them. The "unit" doesn't have to be a full chapter
+(though in some cases it will be), it may be a chapter or a section in
+a chapter.
+
+=============================== ==================== =========== ===================
+User's guide unit Author Status Reviewer
+=============================== ==================== =========== ===================
+contouring Eric ? no author Perry ?
+quiver plots Eric ? no author ?
+quadmesh ? no author ?
+images ? no author ?
+histograms Manuel ? no author Erik Tollerud ?
+bar / errorbar ? no author ?
+x-y plots ? no author ?
+time series plots ? no author ?
+date plots John has author ?
+working with data John has author ?
+custom ticking ? no author ?
+masked data Eric ? no author ?
+text ? no author ?
+patches ? no author ?
+legends ? no author ?
+animation John has author ?
+collections ? no author ?
+mathtext Michael ? submitted John
+fonts et al Michael ? no author ?
+pyplot tut John submitted Eric ?
+usetex Darren ? no author ?
+configuration Darren ? preliminary ?
+colormapping Perry ? no author Eric ?
+win32 install Charlie ? no author ?
+os x install Charlie ? no author ?
+linux install ? no author ?
+artist api John submitted ?
+event handling John submitted ?
+navigation John submitted ?
+interactive usage ? no author ?
+widgets ? no author ?
+ui - gtk ? no author ?
+ui - wx ? no author ?
+ui - tk ? no author ?
+ui - qt Darren ? no author ?
+backend - pdf Jouni ? no author ?
+backend - ps Darren ? no author ?
+backend - svg ? no author ?
+backend - agg ? no author ?
+backend - cairo ? no author ?
+=============================== ==================== =========== ===================
+
+Here is the ouline for the dev guide, much less fleshed out
+
+=============================== ==================== =========== ===================
+Developer's guide unit Author Status Reviewer
+=============================== ==================== =========== ===================
+the renderer John has author Michael ?
+the canvas John has author ?
+the artist John has author ?
+transforms Michael submitted John
+documenting mpl Darren submitted ?
+coding guide John submitted ?
+and_much_more ? ? ?
+=============================== ==================== =========== ===================
+
+And we might want to do a similar table for the FAQ, but that may also be overkill...
+
+If you agree to author a unit, remove the question mark by your name
+(or add your name if there is no candidate), and change the status to
+"has author". Once you have completed draft and checked it in, you
+can change the status to "submitted" and try to find a reviewer if you
+don't have one. The reviewer should read your chapter, test it for
+correctness (eg try your examples) and change the status to "complete"
+when done.
+
+You are free to lift and convert as much material from the web site or
+the existing latex user's guide as you see fit. The more the better.
+
+The UI chapters should give an example or two of using mpl with your
+GUI and any relevant info, such as version, installation, config,
+etc... The backend chapters should cover backend specific
+configuration (eg PS only options), what features are missing, etc...
+
+Please feel free to add units, volunteer to review or author a
+chapter, etc...
+
+It is probably easiest to be an editor. Once you have signed up to be
+an editor, if you have an author pester the author for a submission
+every so often. If you don't have an author, find one, and then pester
+them! Your only two responsibilities are getting your author to
+produce and checking their work, so don't be shy. You *do not* need
+to be an expert in the subject you are editing -- you should know
+something about it and be willing to read, test, give feedback and
+pester!
\ No newline at end of file
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
