nicolaken 2003/10/23 02:48:48 Modified: . README.txt Log: Real and useful readme Revision Changes Path 1.2 +58 -2 incubator/README.txt Index: README.txt =================================================================== RCS file: /home/cvs/incubator/README.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- README.txt 16 Oct 2003 15:45:23 -0000 1.1 +++ README.txt 23 Oct 2003 09:48:48 -0000 1.2 @@ -1,3 +1,59 @@ -Boilerplate Readme -Insert here info about the dir layout and how to generate the website. +Site Change Policy +=================== + +Apache projects usually make releases, and have deliverables. The code +they put in is managed through lazy consensus and voting only when it's +deemed to be required or requested. + +Incubator releases are basically Incubated Projects' release to the +Sponsor PMC. So how incubation is done is our "code". + +Hence there is no need to "ratify" such rules if there seems to be +consensus, as it's much easier to manage. + +Because of this, we do not have the "draft" status on our policy docs +and simply use them as our guide, that will change in need without +having to go through tedious votes when there is good consensus. + + +Website howto +============= + +To generate the website one needs to get CVS forrest and install it. + +Editors can edit the pages without generating the site, and just validate the xml with a validating editor before committing. For the wiki pages it's plain text, so it's easier. Ones with Forrest installed (currently nicolaken) and after the Forrestbot will take care of doing builds, fixing eventual errors and updating the site. + +In any case, if someone wants to check the look of the pages, do this: + + get or update xml-forrest from CVS + run the build script + set FORREST_HOME to point to the build/dist/shbat + add build/dist/shbat/bin to the PATH + + get or update "incubator" from CVS + cd into the local "incubator" CVS dir + execute "forrest run" + point the browser to http://localhost:8888/ to see the site + edit the docs *in place* and see changes in teh browser by reloading the page + + + +Subproject Website howto +======================= + +Do not use the "incubator" CVS module for project docs, but the module of +the specific project. + +Check-in the generated pages in the "incubator-site" CVS module under +\incubator-site\build\site\projects\ftpserver\**. + +When the site is updated from CVS (it's once a day) it will be live. + +If you have other questions, feel free to post them on + [email protected] + +In case of Project development questions, there is + [EMAIL PROTECTED] + +
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
