ZOO-Project Documentation Meeting Summary ========================================= Time ---- February 23 @ 13:00 UTC in #zoo-project channel on IRC Agenda ------ 1. Discuss plan for Sphinx integration in zoo-project.org 2. Server requirements for Sphinx changes 3. Resource requirements (who is doing what for the proposed changes) 4. Timeline for proposed changes 5. Other Attendance ---------- Nicolas Bozon (nbozon) Jeff McKenna (jmckenna) 1. Discuss plan for Sphinx integration in zoo-project.org --------------------------------------------------------- - existing site will be converted to Sphinx layout - Documentation section of this new layout will contain official zoo-project documents, Wiki section will contain user-contributed documents and temporary documents - the Sphinx theme will be modified with a custom layout to match the existing site look - files will be in restructured text format and stored in the ZOO-Project's subversion repository, and then automatically converted to HTML daily - existing wiki material will be minimized, moved into the Sphinx documents, and links to the documents will be placed at the top of the Wiki pages - later on we will experiment with Sphinx's automatic PDF creation 2. Server requirements for Sphinx changes ----------------------------------------- - Sphinx can be installed on ZOO-Project server through Python's easy_install utility - Sphinx install will not take up much space 3. Resource requirements (who is doing what for the proposed changes) --------------------------------------------------------------------- - nbozon to talk to djay to get jmckenna access to server - jmckenna to install Sphinx on ZOO-Project server - nbozon to talk to djay to create a new "Documentation" component for Trac, with a default email CC to nbozon and jmckenna - jmckenna to create Sphinx template on ZOO Project server (visible through something like http://www.zoo-project.org/sphinx) - once template is running, nbozon will modify Sphinx CSS to match existing site - jmckenna to add existing documentation to Sphinx template 4. Timeline for proposed changes -------------------------------- - working Sphinx template and some docs online by end of next week, on the server - CSS/layout modifications after template is online - remaining time will be used to move all docs and wiki refactoring - official launch during the week of March 21-25 - some FacetoFace work on this during the Montreal Code Sprint will occur in March 5. Other -------- - discussed options for managing the SVN for documents. jmckenna proposes that a Subversion group be created with write access to only the documents (at first the group will be Nick, Jeff, Gerald....but other documentation volunteers can be given access) - jmckenna and nbozon agree that a ZOO-Project Documentation Committee be created, that guides the development of the ZOO documentation. Initial members are Nick, Jeff, and Gerald, but all are more than welcome.