You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rave.apache.org by bu...@apache.org on 2011/06/28 23:41:25 UTC
svn commit: r791780 -
/websites/staging/rave/trunk/content/rave/edit-website.html
Author: buildbot
Date: Tue Jun 28 21:41:24 2011
New Revision: 791780
Log:
Staging update by buildbot
Added:
websites/staging/rave/trunk/content/rave/edit-website.html
Added: websites/staging/rave/trunk/content/rave/edit-website.html
==============================================================================
--- websites/staging/rave/trunk/content/rave/edit-website.html (added)
+++ websites/staging/rave/trunk/content/rave/edit-website.html Tue Jun 28 21:41:24 2011
@@ -0,0 +1,163 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+ <link rel="shortcut icon" href="/rave/images/RAVE-icon.ico" type="image/x-icon" />
+ <link href="/rave/css/rave.css" rel="stylesheet" type="text/css">
+ <title>Website editing</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+ <div id="banner">
+ <img id="logo" alt="Apache Rave (Incubating)" src="/rave/images/RAVE-logo_main-logo-small.png"/>
+ </div>
+
+ <div id="navigation">
+ <h1 id="general">General</h1>
+<ul>
+<li><a href="index.html">About</a></li>
+<li><a href="http://incubator.apache.org/projects/rave.html">Incubator page</a></li>
+<li><a href="license.html">License</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="get-involved.html">Get Involved</a></li>
+<li><a href="mailing-lists.html">Mailing Lists</a></li>
+<li><a href="people.html">People</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="source.html">Source Code</a></li>
+<li><a href="release-management.html">Release Management</a></li>
+<li><a href="https://issues.apache.org/jira/browse/rave">Issue Tracker</a></li>
+<li><a href="https://builds.apache.org/hudson/view/M-R/view/Rave/">Continuous Integration</a></li>
+<li><a href="https://analysis.apache.org/dashboard/index/58996">Sonar Dashboard</a></li>
+<li><a href="edit-website.html">Website</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ <a alt="Apache Incubator" href="http://incubator.apache.org">
+ <img id="asf-logo" alt="Apache Incubator" src="/rave/images/apache-incubator-logo.png"/>
+ </a>
+ </div>
+
+ <div id="content">
+ <h1 class="title">Website editing</h1>
+ <p>This HowTo documentation will show the needed steps 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>
+<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>
+</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>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>
+<div class="codehilite"><pre> <span class="n">vi</span> <span class="n">myfile</span><span class="o">.</span><span class="n">mdtext</span>
+ <span class="n">svn</span> <span class="n">ci</span> <span class="o">-</span><span class="n">m</span><span class="s">"My log message"</span> <span class="n">myfile</span><span class="o">.</span><span class="n">mdtext</span>
+</pre></div>
+
+
+<p>Now wait a few seconds so that the entire website can be rebuilt. Then:</p>
+<div class="codehilite"><pre><span class="n">curl</span> <span class="o">-</span><span class="n">sL</span> <span class="n">http:</span><span class="sr">//s</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">cms</span><span class="o">-</span><span class="n">cli</span> <span class="o">|</span> <span class="n">perl</span>
+</pre></div>
+
+
+<p>If this does not work on your local machine just do it on "people.apache.org" by
+executing this:</p>
+<div class="codehilite"><pre><span class="n">ssh</span> <span class="o">-</span><span class="n">t</span> <span class="sr"><user></span><span class="nv">@people</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span> <span class="n">publish</span><span class="o">.</span><span class="n">pl</span> <span class="n">openofficeorg</span> <span class="o"><</span><span class="n">your</span> <span class="n">Apache</span> <span class="n">ID</span><span class="o">></span>
+</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>
+<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='https://cms.apache.org/redirect?uri='+escape(location.href))">Apache CMS</a> bookmarklet to your browser's toolbar.</p>
+<h5 id="apache_id">Apache ID</h5>
+<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
+is displayed as content from the CMS.</p>
+<h4 id="edit_an_existing_webpage">Edit an existing webpage</h4>
+<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
+the directory name (e.g., "docs/") to enter this directory.</p>
+<p>Now you should see a new webpage with a 4 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>
+<li>Below the editor you can enter a log message.</li>
+<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>
+<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>
+<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>
+<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>
+<p><a href="http://www.apache.org/dev/cmsref.html">CMS Documentation Reference</a></p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2011 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>