From: Joe W. <jo...@gm...> - 2012-10-09 19:38:07
|
Hi all, A brief update about the Documentation Push for eXist 2.0: One week has passed since we began this push. Our goal for this week was to create drafts all of the new articles needed to document the new features in eXist 2.0. While we did not meet our goal, we did achieve *quite* a lot: 1. The number of "no draft" entries went from 33 to 18 - so as many as *15 new articles* were contributed to the documentation! 2. The completely new articles are substantive and well done, including: - "Getting Started with Web Application Development" (which covers eXide, the new app bundle format, etc.), - "Learning XQuery" (which gives newbie-friendly pointers to resources for learning XQuery) - "Uploading Files into the Database" (all 6+ ways) - "Running Trunk" (how to get the bleeding edge development version of eXist) - "Performance FAQ" (limits on # of documents & collections, factors involved with performance, scalability) 3. While focusing on contributing new documentation, we have also edited several core articles, including: - "Quick Start", "XQuery Support in eXist-db", and "Security." 4. Many comments were added to the spreadsheet that will help us as we move forward. My deepest thanks to all who have contributed articles, comments, answers, etc.! Without the efforts and energy of all of our volunteers in the eXist-db community, we could not have achieved this. But we still aren't done. So where do we go from here? I propose that we spend *6 more days* completing the remaining outstanding drafts. The reason we need to have drafts of all articles is because until we have a complete set of documentation, it's impossible for me to complete a comprehensive review and edit of the documentation. Also, giving everyone one more week to complete their drafts also gives us time to think of any articles we might have missed or forgotten about -- so if you have an idea, get it in the spreadsheet, and get working. The 18 articles that we still need are marked in red on the spreadsheet (https://docs.google.com/spreadsheet/ccc?key=0AoNLNdpw86LPdDBYNkFXSi1uZG93VThjbzNPTHBaWWc&pli=1#gid=0). The good news is that all but 5 of these 18 articles already have volunteers who've claimed these. If you are willing to contribute a draft (even a rough draft), please check out the spreadsheet, put down your name, add comments and questions. That means: Goal #2 is to complete our drafts of the remaining 18 articles by next Monday, October 15. Thanks again, everyone! Joe P.S. If you already put your name down and can't commit to finishing your drafts by next Monday, please remove your name to indicate that someone else needs to volunteer. No worries - we just need to know so we can plan. P.P.S. If you are interested in contributing by writing or editing articles but don't know how, here's what you need to do: 1. You need to have access to eXist 2.1dev trunk. If you don't, thanks very much, but please wait until the next Preview release of eXist 2.0; you can really help us by beta testing then! 2. Update your working copy of eXist to trunk and rebuild. 3. Before you start eXist, run "build.sh/bat clean-default-data-dir". This will clear the contents of your database and EXPath repository, so back up first. 4. Check out apps/doc from the eXist SVN repo. From your command line, enter the doc directory, and type "ant" to create the .xar app package you'll need to install the documentation app. 5. Start eXist, go to the Dashboard (http://localhost:8080/exist/apps/dashboard/), click on Package Manager, click on the gear/arrow icon in the top-left corner of the window, click on "Select" to browse to the .xar file in the doc/build directory, and click "Upload." When the installation is done, you will find an icon for the Documentation app in the Dashboard list of icons. Click on the icon to enter the documentation. 6. Edit an existing article or create a new article (use template.xml as your template). If you have SVN commit privileges, go ahead and commit the file to apps/doc/data. If you don't, just email me the file, or just email me your notes in a file. I'll do my best to adapt them to an article. |