Author: crossley Date: Thu Jan 13 17:40:09 2005 New Revision: 125128 URL: http://svn.apache.org/viewcvs?view=rev&rev=125128 Log: Clarify the website update process. How to convert from old JSPWiki source to HTML source.
Modified: incubator/public/trunk/site-author/howtoparticipate.html incubator/public/trunk/site-publish/howtoparticipate.html incubator/public/trunk/site-publish/howtoparticipate.pdf Modified: incubator/public/trunk/site-author/howtoparticipate.html Url: http://svn.apache.org/viewcvs/incubator/public/trunk/site-author/howtoparticipate.html?view=diff&rev=125128&p1=incubator/public/trunk/site-author/howtoparticipate.html&r1=125127&p2=incubator/public/trunk/site-author/howtoparticipate.html&r2=125128 ============================================================================== --- incubator/public/trunk/site-author/howtoparticipate.html (original) +++ incubator/public/trunk/site-author/howtoparticipate.html Thu Jan 13 17:40:09 2005 @@ -112,20 +112,28 @@ <p>People with commit access to the "incubator" SVN can edit the source documents in the "site-author/" directory. Anyone else can send patches to those documents.</p> - <p>It's <b>strongly</b> suggested to use plain HTML for the source files. + <p>It is <b>strongly</b> suggested to use plain HTML for the source files. Forrest understands them even if malformed, and generates the site in any case. Use any HTML editor that you prefer, as long as it doesn't mess up too much with the source tags.</p> -<p>When editing the xml source, please ensure xml validation. - When editing the simple JSPWiki source, please take care to use - the correct syntax. - Here are examples of the document structures: +<p>You have a choice of source formats to use: plain HTML, the document-v* series of xdocs, +JSPWiki, others formats which we are not encouraging here. Keep it simple.</p> +<p>When editing xml source, please ensure xml validation (forrest will). + When editing simple JSPWiki source, please take care to use + the correct syntax (forrest cannot). + Here are examples of the source document structures: + <a href="/">html format</a> + and <a href="http://forrest.apache.org/docs/document-v12.html";>xml format</a> and - <a href="http://forrest.apache.org/docs/wiki-sample.html";>JSPWiki format</a>.</p> + <a href="http://forrest.apache.org/docs/wiki-sample.html";>JSPWiki format</a> +</p> <p>You can just commit the source changes and leave it to someone else to generate the website. </p> +<p>Note: Converting from wiki source to html source. A conversion run has been already done. +Do: cd site-author/projects; svn mv mine.cwiki mine.html' and then edit it to replace the old content +with that from projects/TEMP_HTML/mine.html</p> <h3>Generate the production documents</h3> <p>Either install Apache Forrest locally so that you can edit and review documents immediately, or use the production system on @@ -245,19 +253,19 @@ system like Forrest or Maven, or just use simple raw html pages. </p> <p> - Keep your source documents in your project CVS. To publish - your site, simply "cvs commit" your final generated documents + Keep your source documents in your project Version Control System. To publish + your site, simply "commit" your final generated documents to your project "site" module. </p> <p> - To update the website, the project "site" CVS module is + To update the website, the project "site" VCS module is checked-out on the server. PMC members can do this step manually, or perhaps automate it with cron. </p> <pre class="code"> ssh www.apache.org cd /www/incubator.apache.org/${project-name} -cvs update -Pd +cvs update -Pd ... or ... svn up </pre> Modified: incubator/public/trunk/site-publish/howtoparticipate.html Url: http://svn.apache.org/viewcvs/incubator/public/trunk/site-publish/howtoparticipate.html?view=diff&rev=125128&p1=incubator/public/trunk/site-publish/howtoparticipate.html&r1=125127&p2=incubator/public/trunk/site-publish/howtoparticipate.html&r2=125128 ============================================================================== --- incubator/public/trunk/site-publish/howtoparticipate.html (original) +++ incubator/public/trunk/site-publish/howtoparticipate.html Thu Jan 13 17:40:09 2005 @@ -317,10 +317,13 @@ <a name="N10084"></a><a name="Edit+the+content"></a> <h4>Edit the content</h4> <p>People with commit access to the "incubator" SVN can edit the source documents in the "site-author/" directory. Anyone else can send patches to those documents.</p> -<p>It's <strong>strongly</strong> suggested to use plain HTML for the source files. Forrest understands them even if malformed, and generates the site in any case. Use any HTML editor that you prefer, as long as it doesn't mess up too much with the source tags.</p> -<p>When editing the xml source, please ensure xml validation. When editing the simple JSPWiki source, please take care to use the correct syntax. Here are examples of the document structures: <a class="external" href="http://forrest.apache.org/docs/document-v12.html";>xml format</a> and <a class="external" href="http://forrest.apache.org/docs/wiki-sample.html";>JSPWiki format</a>.</p> +<p>It is <strong>strongly</strong> suggested to use plain HTML for the source files. Forrest understands them even if malformed, and generates the site in any case. Use any HTML editor that you prefer, as long as it doesn't mess up too much with the source tags.</p> +<p>You have a choice of source formats to use: plain HTML, the document-v* series of xdocs, JSPWiki, others formats which we are not encouraging here. Keep it simple.</p> +<p>When editing xml source, please ensure xml validation (forrest will). When editing simple JSPWiki source, please take care to use the correct syntax (forrest cannot). Here are examples of the source document structures: <a href="/">html format</a> and <a class="external" href="http://forrest.apache.org/docs/document-v12.html";>xml format</a> and <a class="external" href="http://forrest.apache.org/docs/wiki-sample.html";>JSPWiki format</a> +</p> <p>You can just commit the source changes and leave it to someone else to generate the website.</p> -<a name="N1009B"></a><a name="Generate+the+production+documents"></a> +<p>Note: Converting from wiki source to html source. A conversion run has been already done. Do: cd site-author/projects; svn mv mine.cwiki mine.html' and then edit it to replace the old content with that from projects/TEMP_HTML/mine.html</p> +<a name="N100A2"></a><a name="Generate+the+production+documents"></a> <h4>Generate the production documents</h4> <p>Either install Apache Forrest locally so that you can edit and review documents immediately, or use the production system on the server to generate and copy to a staging site to view them. In the future there will be automated generation and staging systems.</p> <p>Lets explain the server-side method first, then go on to explain how to set up a local Forrest system.</p> @@ -345,7 +348,7 @@ cd /www/incubator.apache.org svn update </pre> -<a name="N100A8"></a><a name="Using+a+local+Forrest+installation"></a> +<a name="N100AF"></a><a name="Using+a+local+Forrest+installation"></a> <h4>Using a local Forrest installation</h4> <p>Install the current release of <a class="external" href="http://forrest.apache.org/";>Apache Forrest</a> (v0.6 release or SVN branch "forrest_06_branch") by following the instructions at the index.html in the distribution, to set the environment variables $FORREST_HOME and $PATH.</p> <p>Checkout the incubator SVN repository. The site source files are kept in the "incubator" SVN at "site-author/". The final website contents are kept in the "incubator" SVN at "site-publish/".</p> @@ -377,18 +380,18 @@ svn update </pre> </div> -<a name="N100E7"></a><a name="Project-specific+resources"></a> +<a name="N100EE"></a><a name="Project-specific+resources"></a> <h2 class="underlined_10">Project-specific resources</h2> <div class="section"> <p>Some <a href="projects/">projects</a> under incubation have their own mailing lists, or their development discussion occurs on the mailing list of another project. Check out the project websites to be sure what mailing list is the right one.</p> -<a name="N100F1"></a><a name="Project+Website+Howto"></a> +<a name="N100F8"></a><a name="Project+Website+Howto"></a> <h3 class="underlined_5">Project Website Howto</h3> <p>Each project can use whatever documentation system that it chooses. Perhaps use a fancy documentation management system like Forrest or Maven, or just use simple raw html pages.</p> -<p>Keep your source documents in your project CVS. To publish your site, simply "cvs commit" your final generated documents to your project "site" module.</p> -<p>To update the website, the project "site" CVS module is checked-out on the server. PMC members can do this step manually, or perhaps automate it with cron.</p> +<p>Keep your source documents in your project Version Control System. To publish your site, simply "commit" your final generated documents to your project "site" module.</p> +<p>To update the website, the project "site" VCS module is checked-out on the server. PMC members can do this step manually, or perhaps automate it with cron.</p> <pre class="code">ssh www.apache.org cd /www/incubator.apache.org/${project-name} -cvs update -Pd +cvs update -Pd ... or ... svn up </pre> </div> </div> Modified: incubator/public/trunk/site-publish/howtoparticipate.pdf Url: http://svn.apache.org/viewcvs/incubator/public/trunk/site-publish/howtoparticipate.pdf?view=diff&rev=125128&p1=incubator/public/trunk/site-publish/howtoparticipate.pdf&r1=125127&p2=incubator/public/trunk/site-publish/howtoparticipate.pdf&r2=125128 ============================================================================== Binary files. No diff available. --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
