incubator-ooo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From w...@apache.org
Subject svn commit: r791877 - in /websites/production/openofficeorg: ./ content/openofficeorg/docs/edit-cms.html content/openofficeorg/people.html
Date Wed, 29 Jun 2011 23:02:52 GMT
Author: wave
Date: Wed Jun 29 23:02:52 2011
New Revision: 791877

Log:
Push changes from adding Kay Schenk to people.mdtext, also edit-cms changes were found.

Modified:
    websites/production/openofficeorg/   (props changed)
    websites/production/openofficeorg/content/openofficeorg/docs/edit-cms.html
    websites/production/openofficeorg/content/openofficeorg/people.html

Propchange: websites/production/openofficeorg/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Wed Jun 29 23:02:52 2011
@@ -1 +1 @@
-/websites/staging/openofficeorg/trunk:791146-791852
+/websites/staging/openofficeorg/trunk:791146-791876

Modified: websites/production/openofficeorg/content/openofficeorg/docs/edit-cms.html
==============================================================================
--- websites/production/openofficeorg/content/openofficeorg/docs/edit-cms.html (original)
+++ websites/production/openofficeorg/content/openofficeorg/docs/edit-cms.html Wed Jun 29
23:02:52 2011
@@ -69,27 +69,34 @@
 
   <div id="content">
     <h1 class="title">How to edit the OpenOffice.org website</h1>
-    <p>This HowTo documentation will show the needed steps to edit the Apache OpenOffice.org
+    <p>This documentation shows how to edit the Apache OpenOffice.org
 website. This includes creation of new pages, modification, and deletion - for files
 and sub-directories.</p>
 <h2 id="how_it_works_in_general">How it works in general</h2>
-<p>The website is hosted in a Content Management System (CMS). You will not edit the
-HTML pages directly. The actual edit is split into two steps:</p>
+<p>The website is hosted in a Content Management System (CMS). When you edit a web
page
+there are potentially four different versions of it to think about:</p>
 <ol>
-<li>
-<p>First you edit the content which is provided as <a href="http://daringfireball.net/projects/markdown/syntax">Markdown
text</a> (mdtext).
-    This will be committed into the staging section (see the SVN commit mail with
-    your log message) and automatically build HTML files out of the the mdtext files
-    (see the commit mail with "Staging update by buildbot" as log messge).</p>
-</li>
-<li>
-<p>Second you need to publish the staging part to the production section (see the
-    commit mail with "Publishing merge to openofficeorg site by <your Apache ID>"
-    as log message).</p>
-</li>
+<li>There is latest version of the page source stored in subversion.</li>
+<li>There is your working copy of that page source, which you are editing.</li>
+<li>There is the generated HTML from that source, in the staging directory.</li>
+<li>There is the production version of the HTML, which is what the public sees.</li>
 </ol>
-<h2 id="what_do_you_prefer_working_via_command_line_or_in_the_browser">What do you
prefer: Working via command line or in the browser?</h2>
-<h3 id="via_command_line">Via command line</h3>
+<p>The general flow for updating the website is:</p>
+<ol>
+<li>You check out latest version of the web pages source.</li>
+<li>You edit the page source using <a href="http://daringfireball.net/projects/markdown/syntax">Markdown
text syntax</a> (mdtext).</li>
+<li>You commit the source into the repository.  You will see the SVN commit mail with
+    your log message</li>
+<li>The commit automatically triggers a build that converts the markdown files 
+into HTML files in the staging directory.  You will see a commit mail with "Staging update
by buildbot" as log messge).</li>
+<li>You verify that the staged webpage is correct and then tell the CMS to publish

+the changes to the production directory.  (You will see a commit mail with "Publishing merge
to openofficeorg site by <your Apache ID>"
+    as log message.)</li>
+</ol>
+<p>The intent of this workflow is to allow committers flexibility in changing 
+webpages and testing changes on a staging website, before moving these changes to
+the public web site.</p>
+<h2 id="command_line_editing_workflow">Command line editing workflow</h2>
 <p>It is assumed that you have already checked out the code from the SVN repository
 (https://svn.apache.org/repos/asf/incubator/ooo).</p>
 <p>Edit the file via your favorite editor like vi and finally commit via SVN:</p>
@@ -109,24 +116,23 @@ executing this:</p>
 </pre></div>
 
 
-<h3 id="editing_in_the_browser">Editing in the browser</h3>
-<h4 id="prerequisites">Prerequisites</h4>
-<h5 id="browser_bookmark">Browser bookmark</h5>
+<h2 id="browser-based_editing_workflow">Browser-based editing workflow</h2>
+<h3 id="prerequisites">Prerequisites</h3>
+<h4 id="browser_bookmark">Browser bookmark</h4>
 <p>Normally you see the webpage in your browser. To update this page with an
-inline-editor and little preview you need to add a link as bookmark to your browser
-(more information see <a href="https://cms.apache.org/#bookmark">here</a>).</p>
-<p>Drag this <a href="javascript:void(location.href=&apos;https://cms.apache.org/redirect?uri=&apos;+escape(location.href))">Apache
CMS</a> bookmarklet to your browser's toolbar.</p>
-<h5 id="apache_id">Apache ID</h5>
+inline-editor and little preview you use the <a href="javascript:void(location.href=&apos;https://cms.apache.org/redirect?uri=&apos;+escape(location.href))">Apache
CMS</a> JavaScript bookmarklet.  Drag that 
+link to your browser's toolbar.  For more information see <a href="https://cms.apache.org/#bookmark">here</a>.</p>
+<h4 id="apache_id">Apache ID</h4>
 <p>Furthermore, you need an Apache ID to authenticate to the system.</p>
-<h4 id="starting">Starting</h4>
-<p>Browse to the respective webpage or directory you would like to edit and click on
-the bookmark. Now click on the [Edit this directory] link on the top. The following
+<h3 id="starting">Starting</h3>
+<p>Browse to the webpage or directory you would like to edit and click on
+the bookmarklet. Now click on the [Edit this directory] link on the top. The following
 is displayed as content from the CMS.</p>
-<h4 id="edit_an_existing_webpage">Edit an existing webpage</h4>
+<h3 id="edit_an_existing_webpage">Edit an existing webpage</h3>
 <p>Click on the actions link [Edit] in the appropriate table cell for editing the
-favorite file. If the file is not in this directory but in a subdir, just click on
+current file. If the file is not in this directory but in a subdirectory, just click on
 the directory name (e.g., "docs/") to enter this directory.</p>
-<p>Now you should see a new webpage with a 4 fields:</p>
+<p>Now you should see a new webpage with four fields:</p>
 <ol>
 <li>Upper left is the inline editor for text in markdown syntax.</li>
 <li>Upper right shows the written text as a permanent preview or as HTML source code.</li>
@@ -134,21 +140,34 @@ the directory name (e.g., "docs/") to en
 <li>Enter a general header text, e.g., the license of the entered text.</li>
 </ol>
 <p>When you have finished writing your text, check the "Log message" box, enter a
-commit message and click on [Submit].</p>
-<h4 id="create_a_new_webpage">Create a new webpage</h4>
+commit message and click on [Submit].  This commits your changes to the Subversion 
+repository.</p>
+<h3 id="verifying_the_staged_web_site">Verifying the staged web site</h3>
+<p>As noted above, committing your changes triggers a build of the markdown files
+into HTML in the staging directory.  This could take 15-30 seconds.  So wait a few
+seconds and then click the [Staged] link to view your web page as staged.</p>
+<p>At this point you should test your web page.  Does it look right?  Any spelling

+errors? Do the links work?  If you've made substantial changes, perhaps test in
+more than one browser.</p>
+<p>Once you are satisfied that the page is correct, you are ready to publish it
+to the production site.</p>
+<h3 id="publishing_to_the_production_directory">Publishing to the production directory</h3>
+<p>After you have edited your files and/or directories, you need now to publish your
+modifications into production. For this please click on the link
+[Publish site] on the top of the webpage. Enter a commit message on click 
+on [Submit].  After a few seconds you can check the [Production] link to see the
+live version of your changes.<br />
+</p>
+<h3 id="create_a_new_webpage">Create a new webpage</h3>
 <p>When in the correct directory, at the top enter a name for the new text file (e.g.,
 "my-file.mdtext"). Now you enter your text (see topic above).</p>
-<h4 id="create_new_subdirectory">Create new subdirectory</h4>
+<h3 id="create_new_subdirectory">Create new subdirectory</h3>
 <p>When in the correct directory, at the top enter a name for the new directory (e.g.,
 "my-dir/"). Make sure you entered a trailing "/"!</p>
-<h4 id="delete_a_webpage_or_subdirectory">Delete a webpage or subdirectory</h4>
+<h3 id="delete_a_webpage_or_subdirectory">Delete a webpage or subdirectory</h3>
 <p>When in the correct directory, click on the actions link [Delete] in the appropriate
 table cell and enter a commit message. Finally click on [Submit].</p>
-<h4 id="how_to_put_into_production">How to put into production?</h4>
-<p>After you have edited your files and/or directories, you need now to pubish your
-modifications into production. For this please click on the link
-[Publish site] on the top of the webpage. Enter a commit message on click on [Submit].</p>
-<h3 id="links">Links</h3>
+<h2 id="links">Links</h2>
 <p><a href="http://www.apache.org/dev/cmsref.html">CMS Documentation Reference</a></p>
   </div>
 

Modified: websites/production/openofficeorg/content/openofficeorg/people.html
==============================================================================
--- websites/production/openofficeorg/content/openofficeorg/people.html (original)
+++ websites/production/openofficeorg/content/openofficeorg/people.html Wed Jun 29 23:02:52
2011
@@ -86,8 +86,9 @@ to look at all contributors to our issue
     <tr><td>cmarcum</td><td>Carl Marcum</td><td>Dayton,
OH, USA</td><td>Java, Groovy, SDK API's, XML</td></tr>
     <tr><td>elproferoman</td><td><a href="http://piensalibre.com.ar">Roman
Gelbort</a></td><td>Buenos Aires, Argentina</td><td>Marketing,
Education, User Support</td></tr>
     <tr><td>robweir</td><td><a href="http://www.robweir.com/blog">Rob
Weir</a></td><td>Westford, MA, USA</td><td>C/C++, Java, Python,
XML, ODF, Performance tuning</td></tr>
-<tr><td>dpharbison</td><td>Don Harbison</td><td>Chelmsford,
MA USA</td><td>Trademark, Branding, Communications, Community Development</td></tr>
-<tr><td>jeanweber</td><td><a href="http://taming-openoffice-org.com/">Jean
Hollis Weber</a></td><td>Townsville, QLD, Australia</td><td>Technical
writing/editing/publishing of end-user documentation</td></tr>
+    <tr><td>dpharbison</td><td>Don Harbison</td><td>Chelmsford,
MA USA</td><td>Trademark, Branding, Communications, Community Development</td></tr>
+    <tr><td>jeanweber</td><td><a href="http://taming-openoffice-org.com/">Jean
Hollis Weber</a></td><td>Townsville, QLD, Australia</td><td>Technical
writing/editing/publishing of end-user documentation</td></tr>
+    <tr><td></td><td>Kay Schenk</td><td>Chico, CA, USA</td><td>HTML,
CSS, Javascript, Java, Perl, general technical writing</td></tr>
 </table>
 </table>
   </div>



Mime
View raw message