|
| 1 | +.. _outline: |
| 2 | + |
| 3 | +************ |
| 4 | +Docs outline |
| 5 | +************ |
| 6 | + |
| 7 | +Proposed chapters for the docs, who has responsibility for them, and |
| 8 | +who reviews them. The "unit" doesn't have to be a full chapter |
| 9 | +(though in some cases it will be), it may be a chapter or a section in |
| 10 | +a chapter. |
| 11 | + |
| 12 | +=============================== ==================== =========== =================== |
| 13 | +User's guide unit Author Status Reviewer |
| 14 | +=============================== ==================== =========== =================== |
| 15 | +contouring Eric ? no author Perry ? |
| 16 | +quiver plots Eric ? no author ? |
| 17 | +quadmesh ? no author ? |
| 18 | +images ? no author ? |
| 19 | +histograms Manuel ? no author Erik Tollerud ? |
| 20 | +bar / errorbar ? no author ? |
| 21 | +x-y plots ? no author ? |
| 22 | +time series plots ? no author ? |
| 23 | +date plots John has author ? |
| 24 | +working with data John has author ? |
| 25 | +custom ticking ? no author ? |
| 26 | +masked data Eric ? no author ? |
| 27 | +text ? no author ? |
| 28 | +patches ? no author ? |
| 29 | +legends ? no author ? |
| 30 | +animation John has author ? |
| 31 | +collections ? no author ? |
| 32 | +mathtext Michael ? submitted John |
| 33 | +fonts et al Michael ? no author ? |
| 34 | +pyplot tut John submitted Eric ? |
| 35 | +usetex Darren ? no author ? |
| 36 | +configuration Darren ? preliminary ? |
| 37 | +colormapping Perry ? no author Eric ? |
| 38 | +win32 install Charlie ? no author ? |
| 39 | +os x install Charlie ? no author ? |
| 40 | +linux install ? no author ? |
| 41 | +artist api John submitted ? |
| 42 | +event handling John submitted ? |
| 43 | +navigation John submitted ? |
| 44 | +interactive usage ? no author ? |
| 45 | +widgets ? no author ? |
| 46 | +ui - gtk ? no author ? |
| 47 | +ui - wx ? no author ? |
| 48 | +ui - tk ? no author ? |
| 49 | +ui - qt Darren ? no author ? |
| 50 | +backend - pdf Jouni ? no author ? |
| 51 | +backend - ps Darren ? no author ? |
| 52 | +backend - svg ? no author ? |
| 53 | +backend - agg ? no author ? |
| 54 | +backend - cairo ? no author ? |
| 55 | +=============================== ==================== =========== =================== |
| 56 | + |
| 57 | +Here is the ouline for the dev guide, much less fleshed out |
| 58 | + |
| 59 | +=============================== ==================== =========== =================== |
| 60 | +Developer's guide unit Author Status Reviewer |
| 61 | +=============================== ==================== =========== =================== |
| 62 | +the renderer John has author Michael ? |
| 63 | +the canvas John has author ? |
| 64 | +the artist John has author ? |
| 65 | +transforms Michael submitted John |
| 66 | +documenting mpl Darren submitted ? |
| 67 | +coding guide John submitted ? |
| 68 | +and_much_more ? ? ? |
| 69 | +=============================== ==================== =========== =================== |
| 70 | + |
| 71 | +And we might want to do a similar table for the FAQ, but that may also be overkill... |
| 72 | + |
| 73 | +If you agree to author a unit, remove the question mark by your name |
| 74 | +(or add your name if there is no candidate), and change the status to |
| 75 | +"has author". Once you have completed draft and checked it in, you |
| 76 | +can change the status to "submitted" and try to find a reviewer if you |
| 77 | +don't have one. The reviewer should read your chapter, test it for |
| 78 | +correctness (eg try your examples) and change the status to "complete" |
| 79 | +when done. |
| 80 | + |
| 81 | +You are free to lift and convert as much material from the web site or |
| 82 | +the existing latex user's guide as you see fit. The more the better. |
| 83 | + |
| 84 | +The UI chapters should give an example or two of using mpl with your |
| 85 | +GUI and any relevant info, such as version, installation, config, |
| 86 | +etc... The backend chapters should cover backend specific |
| 87 | +configuration (eg PS only options), what features are missing, etc... |
| 88 | + |
| 89 | +Please feel free to add units, volunteer to review or author a |
| 90 | +chapter, etc... |
| 91 | + |
| 92 | +It is probably easiest to be an editor. Once you have signed up to be |
| 93 | +an editor, if you have an author pester the author for a submission |
| 94 | +every so often. If you don't have an author, find one, and then pester |
| 95 | +them! Your only two responsibilities are getting your author to |
| 96 | +produce and checking their work, so don't be shy. You *do not* need |
| 97 | +to be an expert in the subject you are editing -- you should know |
| 98 | +something about it and be willing to read, test, give feedback and |
| 99 | +pester! |
0 commit comments