You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stratos.apache.org by bu...@apache.org on 2013/07/14 18:25:29 UTC
svn commit: r869455 - in /websites/staging/stratos/trunk/content: ./
development/test.html
Author: buildbot
Date: Sun Jul 14 16:25:28 2013
New Revision: 869455
Log:
Staging update by buildbot for stratos
Added:
websites/staging/stratos/trunk/content/development/test.html
Modified:
websites/staging/stratos/trunk/content/ (props changed)
Propchange: websites/staging/stratos/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sun Jul 14 16:25:28 2013
@@ -1 +1 @@
-1502611
+1502988
Added: websites/staging/stratos/trunk/content/development/test.html
==============================================================================
--- websites/staging/stratos/trunk/content/development/test.html (added)
+++ websites/staging/stratos/trunk/content/development/test.html Sun Jul 14 16:25:28 2013
@@ -0,0 +1,196 @@
+<!DOCTYPE html>
+<html lang="en">
+<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="stylesheet" type="text/css" media="screen" href="/css/bootstrap.min.css">
+ <style type="text/css">
+ body {
+ padding-top: 60px;
+ padding-bottom: 40px;
+ }
+ .sidebar-nav {
+ padding: 9px 0;
+ }
+ @media (max-width: 980px) {
+ /* Enable use of floated navbar text */
+ .navbar-text.pull-right {
+ float: none;
+ padding-left: 5px;
+ padding-right: 5px;
+ }
+ }
+ </style>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/bootstrap-responsive.min.css">
+ <title>How to edit the Apache Stratos website</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+
+<div class="navbar navbar-inverse navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span> </a>
+ <a class="brand" href="/index.html">Apache Stratos</a>
+ <div class="nav-collapse">
+ <ul class="nav">
+ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">Development<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/development/source.html">Source Code</a></li>
+ <li><a href="/development/license.html">Project License</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/stratos">Issue Tracker</a></li>
+ <li><a href="/development/edit-website.html">Editing Website</a></li>
+ </ul>
+ </li>
+ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">Documentation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="https://cwiki.apache.org/confluence/display/STRATOS/Index">Stratos Wiki</a></li>
+ </ul>
+ </li>
+ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/community/mailing-lists.html">Mailing Lists</a></li>
+ <li><a href="/community/people.html">Project Team</a></li>
+ <li><a href="/community/get-involved.html">Get Involved</a></li>
+ </ul>
+ </li>
+ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <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>
+ </ul>
+ </li>
+ </ul>
+ </div> <!-- /.nav-collapse -->
+ </div><!-- /.container -->
+ </div><!-- /.navbar-inner -->
+ </div>
+
+ <div id="main" role="main" class="container">
+ <section id="content" class="row">
+ <article class="span12">
+ <p>This HowTo documentation will show the needed steps to edit the stratos
+website. This includes creation of new pages, modification, and deletion - for files
+and sub-directories.stratos</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 up in 2 parts:</p>
+<ol>
+<li>
+<p>First you edit the content which is provided as <a href="http://en.wikipedia.org/wiki/Markdown">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).
+ Before you publish youe changes in next step, you can verify the changes on the staging site</p>
+<ul>
+<li><a href="http://stratos.staging.apache.org/">http://stratos.staging.apache.org/</a>. </li>
+</ul>
+</li>
+<li>
+<p>Second you need to publish the staging part to the production section (see the
+ commit mail with "Publishing merge to stratos site by <your Apache ID>"
+ as log message).</p>
+</li>
+</ol>
+<h2 id="what-do-you-prefer-working-via-commandline-or-in-the-browser">What do you prefer: Working via commandline or in the browser?</h2>
+<h3 id="via-commandline">Via commandline</h3>
+<p>It is assumed that you have already checked out the code from the SVN repository
+<a href="https://svn.apache.org/repos/asf/incubator/stratos/site/trunk/">https://svn.apache.org/repos/asf/incubator/stratos/site/trunk/</a>.</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="p">.</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="n">My</span> <span class="nb">log</span> <span class="n">message</span>" <span class="n">myfile</span><span class="p">.</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="p">:</span><span class="o">//</span><span class="n">s</span><span class="p">.</span><span class="n">apache</span><span class="p">.</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="o"><</span><span class="n">user</span><span class="o">></span><span class="p">@</span><span class="n">people</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span> <span class="n">publish</span><span class="p">.</span><span class="n">pl</span> <span class="n">stratos</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><a href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))">Add this link as bookmark</a></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 corrext 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].
+Alterantively you can click on this <a href="https://cms.apache.org/stratos/publish">pubish link</a>, review the diff's and submit.</p>
+<h3 id="links">Links</h3>
+<p><a href="http://www.apache.org/dev/cmsref.html">CMS Documentation Reference</a></p>
+ </article>
+ </section>
+ </div>
+
+ <footer class="footer" align="center">
+ <div class="container">
+ <a alt="Apache Incubator" href="http://incubator.apache.org">
+ <img id="asf-logo" alt="Apache Incubator" src="http://incubator.apache.org/images/egg-logo.png" width="150"/></a>
+ <p>Copyright © 2013 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 SIS, Apache, the Apache feather logo are trademarks of The Apache Software Foundation.</p>
+ </div>
+ </footer>
+
+ <script src="/js/jquery-1.9.1.min.js"></script>
+ <script src="/js/bootstrap.min.js"></script>
+
+</body>
+</html>