Author: buildbot
Date: Fri Jul 15 18:46:49 2016
New Revision: 992900
Log:
Staging update by buildbot for taverna
Modified:
websites/staging/taverna/trunk/cgi-bin/ (props changed)
websites/staging/taverna/trunk/content/ (props changed)
websites/staging/taverna/trunk/content/community/edit.html
Propchange: websites/staging/taverna/trunk/cgi-bin/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Jul 15 18:46:49 2016
@@ -1 +1 @@
-1752850
+1752864
Propchange: websites/staging/taverna/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Jul 15 18:46:49 2016
@@ -1 +1 @@
-1752850
+1752864
Modified: websites/staging/taverna/trunk/content/community/edit.html
==============================================================================
--- websites/staging/taverna/trunk/content/community/edit.html (original)
+++ websites/staging/taverna/trunk/content/community/edit.html Fri Jul 15
18:46:49 2016
@@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
- <title>Apache Taverna - Edit Instructions</title>
+ <title>Apache Taverna - Editing the Website</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<meta property="og:image" content="/img/taverna-logo-145x134.png" />
@@ -32,7 +32,7 @@
"@context" : "http://schema.org";,
"@type" : ["CreativeWork"],
"@id": "",
- "name" : "Edit Instructions",
+ "name" : "Editing the Website",
"publisher" : {
"@type" : "Organization",
"url" : "http://www.apache.org/";,
@@ -173,7 +173,7 @@
<div id="page" class="container">
- <h1>Edit Instructions</h1>
+ <h1>Editing the Website</h1>
<div id="content"><style type="text/css">
/* The following code is added by mdx_elementid.py
It was originally lifted from http://subversion.apache.org/style/site.css */
@@ -185,120 +185,211 @@
visibility: hidden;
}
h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
-<p>The Apache Taverna website is maintained as a community effort.
+<p>The Apache Taverna website is maintained through a community effort.
No matter your affiliation to the project, please help us improve the website
by
suggesting edits of any of the pages!</p>
-<h1 id="overview">Overview<a class="headerlink" href="#overview"
title="Permanent link">¶</a></h1>
-<p>Apache Taverna's webpages are managed by the <a
href="http://www.apache.org/dev/cmsref.html";>Apache CMS</a> system, and
-(if the file extension is <code>.md</code>) written in the <a
href="https://www.apache.org/dev/cmsref.html#markdown";>Markdown format</a>.</p>
-<p>The raw pages are stored in the <a
href="http://svn.apache.org/repos/asf/incubator/taverna/site/";>SVN repository
asf/incubator/taverna/site</a>, but should be edited using one of the methods
below:</p>
-<h1 id="github-pull-requests">Github pull requests<a class="headerlink"
href="#github-pull-requests" title="Permanent link">¶</a></h1>
+<h2 id="overview">Overview<a class="headerlink" href="#overview"
title="Permanent link">¶</a></h2>
+<p>Apache Taverna's web pages are managed by the <a
href="http://www.apache.org/dev/cmsref.html";>Apache CMS</a> system, and most
are written in <a
href="https://www.apache.org/dev/cmsref.html#markdown";>Markdown</a>. (These
will have a <code>.md</code> file extension.)</p>
+<blockquote>
+<p>Edit the web pages using either
+<a href="#github">GitHub pull requests</a>
+or the <a href="#apache-cms">Apache CMS</a>, as described below.</p>
+</blockquote>
+<p>Please follow the <a href="#editing-tips">editing guidelines</a> when
making changes.</p>
+<p>(Raw pages are stored in the <a
href="http://svn.apache.org/repos/asf/incubator/taverna/site/";>SVN repository
asf/incubator/taverna/site</a>.)</p>
+<p><a name=github></a></p>
+<h2 id="github-pull-requests">Github pull requests<a class="headerlink"
href="#github-pull-requests" title="Permanent link">¶</a></h2>
<p>The source for the Apache Taverna website is mirrored to the GitHub project
<a
href="https://github.com/apache/incubator-taverna-site/tree/trunk/content";>incubator-taverna-site</a>,
-where you can navigate to the source for the page you want to edit. <em>Anyone
with a GitHub account</em>
+where you can navigate to the source for the page you want to edit.</p>
+<blockquote>
+<p><em>Anyone with a GitHub account</em>
can suggest an edit to an Apache Taverna page directly in the browser.</p>
-<p>Note that GitHub's rendering of the Markdown is not 100% equivalent to the
resulting HTML
+</blockquote>
+<p>Note that <strong>GitHub's rendering of the Markdown is not 100%
equivalent</strong> to the resulting HTML
within the Apache CMS. In particular, the <code>Title:</code> and
<code>License:</code> headers at the top
of every <code>.md</code> file will not be rendered as shown on GitHub.</p>
<p>To submit your suggested change, raise a
-<a href="https://github.com/apache/incubator-taverna-site/pulls";>GitHub pull
request</a>
-which will send an email on your behalf to the
+<a href="https://github.com/apache/incubator-taverna-site/pulls";>GitHub pull
request</a>.
+This will send an email on your behalf to the
<a href="/community/lists#devtaverna">dev@taverna mailing list</a>, where
an Apache Taverna committer will review your change before making it live
-on the Apache Taverna website.
+on the website.
Please sign up to <a href="/community/lists#devtaverna">dev@taverna</a>
to watch for to any follow-up comments about your changes.</p>
-<h1 id="apache-cms">Apache CMS<a class="headerlink" href="#apache-cms"
title="Permanent link">¶</a></h1>
-<p>If you are an Apache Taverna <strong>committer</strong>, then use the
+<p><a name=apache-cms></a></p>
+<h2 id="apache-cms">Apache CMS<a class="headerlink" href="#apache-cms"
title="Permanent link">¶</a></h2>
+<p>If you are an <strong>Apache Taverna committer</strong>, use the
<a href="http://www.apache.org/dev/cmsref.html";>Apache CMS</a> directly from
<a href="https://cms.apache.org/taverna/";>https://cms.apache.org/taverna/</a>
using your <code>@apache.org</code> account as login.</p>
-<p>You can also drag this bookmarklet to your browser toolbar or bookmark
collection,
-which you can click from any Apache Taverna page you want to edit:</p>
-<ul>
-<li><a
href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))">Edit
in CMS</a></li>
-</ul>
-<h2 id="non-taverna-committers">Non-Taverna committers<a class="headerlink"
href="#non-taverna-committers" title="Permanent link">¶</a></h2>
+<p>Committers can also drag the
+<a
href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))">Edit
in CMS</a>
+ bookmarklet to your browser toolbar or bookmark collection.</p>
+<p>See <a href="#cms-for-committers">CMS usage for committers</a> for how to
use the Apache CMS.</p>
+<h3 id="non-taverna-apache-committers">Non-Taverna Apache committers<a
class="headerlink" href="#non-taverna-apache-committers" title="Permanent
link">¶</a></h3>
<p>If you are an existing
<a href="https://people.apache.org/phonebook.html?unix=committers";>Apache
committer</a>,
but don't have write access to the pages
-(e.g. you are not in the <code>incubator</code> group), then your suggested
edit will be sent as
- an suggested patch to the
-<a href="/community/lists#devtaverna">dev@taverna</a> mailing list,
-which you should subscribe to in order to respond to any feedback.</p>
-<h2 id="anonymous-use-of-cms">Anonymous use of CMS<a class="headerlink"
href="#anonymous-use-of-cms" title="Permanent link">¶</a></h2>
+(e.g. you are not in the <code>incubator</code> group), your edit will be
sent as a
+ suggested patch to the
+<a href="/community/lists#devtaverna">dev@taverna</a> mailing list.
+Subscribe to the mailing list to respond to any feedback.</p>
+<h3 id="anonymous-use-of-cms">Anonymous use of CMS<a class="headerlink"
href="#anonymous-use-of-cms" title="Permanent link">¶</a></h3>
+<blockquote>
<p>It is possible to log on to the
<a href="http://www.apache.org/dev/cmsref.html#faq";>CMS without an Apache
account</a>,
-by using the username <code>anonymous</code> and an empty password.
-This can be beneficial if you
+by using the username <code>anonymous</code> and an empty password.</p>
+</blockquote>
+<p>This can be beneficial if you
prefer not to use GitHub, or if you want to suggest larger changes that
involve renames, etc.</p>
-<p>Note that in this case your suggested edit will be sent as an suggested
patch to the
+<p>Note that in this case your edit will be sent as a suggested patch to the
<a href="/community/lists#devtaverna">dev@taverna</a> mailing list,
which you should subscribe to in order to respond to any feedback.</p>
+<p><a name=cms-for-committers></a></p>
<h2 id="cms-usage-for-committers">CMS usage for committers<a
class="headerlink" href="#cms-usage-for-committers" title="Permanent
link">¶</a></h2>
+<p>Before editing an Apache Taverna web page, familiarize yourself with the <a
href="http://www.apache.org/dev/cmsref.html#flow";>CMS information flow</a>.</p>
+<blockquote>
+<p>IMPORTANT: <em>[Update]</em> the page or directory before you start
editing. Otherwise, you may not be working on the current version.</p>
+</blockquote>
<p>For details, see the <a href="http://www.apache.org/dev/cmsref.html";>Apache
CMS reference</a>.</p>
-<p>In short, follow this pattern:</p>
+<h3 id="opening-the-file">Opening the file<a class="headerlink"
href="#opening-the-file" title="Permanent link">¶</a></h3>
+<p>Open the file in the editor using the <strong>Edit in CMS</strong>
bookmarklet:</p>
+<ul>
+<li>Navigate to the page you want to edit</li>
+<li>Click the bookmarklet and log in</li>
+<li>Click <code>[Update]</code> to refresh the page</li>
+<li>Click <code>[Edit]</code> to enter the editor</li>
+</ul>
+<p><em>Or</em> use the [Apache CMS]((https://cms.apache.org/taverna/):</p>
<ul>
-<li><code>Get taverna Working Copy</code></li>
-<li>Click on <code>Parent Directory</code> where you then click <code>[Update
this directory]</code></li>
+<li>Click <code>Get taverna Working Copy</code></li>
+<li>Click on <code>Parent Directory</code>, and then click <code>[Update this
directory]</code></li>
<li><code>Browse</code> to the correct folder under <code>content/</code></li>
+<li><code>[Edit]</code> the file(s)</li>
+</ul>
+<h3 id="committing-and-publishing-your-changes">Committing and publishing your
changes<a class="headerlink" href="#committing-and-publishing-your-changes"
title="Permanent link">¶</a></h3>
+<ul>
<li>
-<p><code>[Edit]</code> the file(s)</p>
+<p>Tick <code>Quick Commit : [ ]</code> and click <code>Submit</code>
+ ** You forgot the Quick Commit? No problem! Now click <code>[Commit]</code>
followed by <code>Submit</code>.</p>
</li>
<li>
-<p>Tick <code>Quick Commit : [ ]</code> and click <code>Submit</code>
- ** You forgot the Quick Commit? Now click <code>[Commit]</code> followed by
<code>Submit</code></p>
+<p>Click <code>[View Staging Build]</code> to see if CMS has built your
changes. Usually
+ this is quite quick. Refresh the page, as necessary, to make sure there are
no "Current" or "Pending" jobs before you continue.</p>
</li>
-<li>Click/Refresh <code>[View Staging Build]</code> to see if CMS has built
your changes. Usually
- this is quite quick. there should be no "Current" or "Pending" jobs.</li>
-<li>Click <code>[Staging]</code> to see the result of your change (and anyone
else's at the same time)
+<li>
+<p>Click <code>[Staging]</code> to see the result of your change (and anyone
else's at the same time)
at the temporary
- <a
href="http://taverna.staging.apache.org/";>http://taverna.staging.apache.org/</a>
site.</li>
-<li>If you are happy, go back and click <code>[Publish]</code> followed by
<code>[Submit]</code>,
- otherwise keep editing</li>
+ <a
href="http://taverna.staging.apache.org/";>http://taverna.staging.apache.org/</a>
site.</p>
+</li>
+<li>
+<p>If you are happy, go back and click <code>[Publish]</code> followed by
<code>[Submit]</code>,
+ otherwise keep editing</p>
+</li>
</ul>
+<p><a name=editing-tips></a></p>
<h2 id="editing-tips">Editing tips<a class="headerlink" href="#editing-tips"
title="Permanent link">¶</a></h2>
-<p>Writing tips:</p>
+<h3 id="writing-tips">Writing tips:<a class="headerlink" href="#writing-tips"
title="Permanent link">¶</a></h3>
+<ul>
+<li>
+<p><strong>Keep it simple.</strong> Use <a
href="https://en.wikipedia.org/wiki/Plain_English";>Plain English</a>.</p>
+</li>
+<li>
+<p><strong>Focus on the main questions</strong> you imagine will be faced by
someone new to the topic, rather than explaining every possibility.</p>
+</li>
+</ul>
+<h3 id="linking-tips">Linking tips:<a class="headerlink" href="#linking-tips"
title="Permanent link">¶</a></h3>
+<ul>
+<li>
+<p><strong>Avoid <a href="http://www.cs.tut.fi/~jkorpela/www/click.html";>click
here</a> links.</strong> Link text should be understandable and flow with the
text. Rewrite the sentence, if needed.</p>
+<ul>
+<li>
+<p>YES: <em>"Code is generated automatically by the <a
href="#">CodeGenerator</a> class."</em></p>
+</li>
+<li>
+<p>NO: <em>"Code generation is automatic. More information is in <a
href="#">svn</a>."</em></p>
+</li>
+</ul>
+</li>
+<li>
+<p><strong>Don't duplicate information.</strong> Link to existing pages - but
provide sufficient context.</p>
+<ul>
+<li>
+<p>YES: <code>Contact the [dev@taverna mailing list](/community/lists) for
questions about the Maven plugin.</code> </p>
+</li>
+<li>
+<p>NO: <code>Contact the [dev@taverna mailing list](/community/lists).</code>
</p>
+</li>
+</ul>
+</li>
+<li>
+<p><strong>Everything is easier with a link.</strong></p>
+<ul>
+<li>
+<p>Don't just say "You can find more in the documentation" - link to the right
place in the documentation.</p>
+</li>
+<li>
+<p>Deep-links are good, unless the target pages become confusing out of
context.</p>
+</li>
+</ul>
+</li>
+<li>
+<p><strong>Don't break existing hyperlinks</strong> to our pages. (They could
be linked-to anywhere on the web.)</p>
<ul>
-<li>Keep it simple. Use <a
href="https://en.wikipedia.org/wiki/Plain_English";>Plain English</a>.</li>
-<li>Rather than explaining every possibility, focus on the main questions you
imagine faced by someone new to the topic.</li>
+<li>
+<p>Keep the URI of a page as much as possible, or use <code>.htaccess</code>
redirections.</p>
+</li>
+<li>
+<p>If a page has been deleted, leave a placeholder page explaining why.</p>
+</li>
+<li>
+<p>Remove/update internal links to deleted/moved pages. (<code>svn</code> and
<code>grep</code> are your friends.)</p>
+</li>
</ul>
-<p>Linking tips:</p>
+</li>
+<li>
+<p><strong>Start internal links with <code>/</code></strong> unless they are
part of the same sub-folder.</p>
+</li>
+<li>
+<p><strong>Don't include extensions</strong> (<code>.html</code> or
<code>.cgi</code>) in the internal links. It doesn't just look nice, this gives
us flexibility to later use a folder <code>page/</code> instead of
<code>page.html</code>.</p>
+<ul>
+<li>
+<p>YES: <code>/introduction/why-use-workflows</code></p>
+</li>
+<li>
+<p>NO: <code>/introduction/why-use-workflows.html</code> </p>
+</li>
+</ul>
+</li>
+<li>
+<p><strong>Link to source code.</strong> More people may appreciate it than
you think. Who knows, maybe a patch is around the corner?</p>
<ul>
-<li><a href="http://www.cs.tut.fi/~jkorpela/www/click.html";>click here</a>
links considered harmful.</li>
-<li>Make link texts that make sense alone, but also flows with the text.
Rewrite the sentence if needed.</li>
-<li>Example: Instead of<ul>
-<li><del><em>"Code generation is automatic. More information is in <a
href="#">svn</a>"</em></del>, try:</li>
-<li><em>"Code is generated automatically by the <a href="#">CodeGenerator</a>
class"</em></li>
-</ul>
-</li>
-<li>Don't duplicate information. Link to existing pages - but provide
sufficient context.</li>
-<li>Example: <code>Contact the [dev@taverna mailing list](/community/lists)
for questions about the Maven plugin"</code></li>
-<li>Everything is easier with a link.</li>
-<li>Don't just say "You can find more in the documentation" - link to the
right place in the documentation.</li>
-<li>Deep-links are good, unless the target pages becomes confusing out of
context</li>
-<li>Don't break existing hyperlinks to our pages (they could be linked to
anywhere on the web)</li>
-<li>Keep the URI of a page as far as possible, or use <code>.htaccess</code>
redirections.</li>
-<li>If a page has been deleted, leave a placeholder page explaining why.<ul>
-<li>Remove/update internal links to deleted/moved pages. (<code>svn</code> and
<code>grep</code> are your friends)</li>
-</ul>
-</li>
-<li>Start internal links with <code>/</code> unless they are part of the same
sub-folder.</li>
-<li><strong>Don't</strong> include extensions <code>.html</code> or
<code>.cgi</code> in the internal links</li>
-<li>e.g.
-link to <code>/introduction/why-use-workflows</code> rather than
<code>/introduction/why-use-workflows.html</code></li>
-<li>It doesn't just look nice, this gives us flexibility to later use a folder
<code>page/</code> instead of <code>page.html</code></li>
-<li>Don't be afraid to link to source code - more people may appreciate it
than you think. Who knows, maybe a patch is around the corner?</li>
<li>Deep-link to source folder/file under the <code>incubator-taverna-*</code>
project at
<a href="http://github.com/apache/";>GitHub</a></li>
</ul>
-<p>If you are adding a new page:</p>
+</li>
+</ul>
+<h3 id="if-you-are-adding-a-new-page">If you are adding a new page:<a
class="headerlink" href="#if-you-are-adding-a-new-page" title="Permanent
link">¶</a></h3>
+<ul>
+<li>
+<p><strong>Use a short, neutral and sensible URI</strong></p>
+<ul>
+<li>
+<p>YES: <code>community/lists</code></p>
+</li>
+<li>
+<p>NO: <code>the%20taverna%20community/contact-us-2</code></p>
+</li>
+</ul>
+</li>
+<li>
+<p><strong>Link from/to relevant existing Apache Taverna pages</strong> (not
just the hierarchical parent).</p>
+</li>
+</ul>
+<p>For example, if <code>/code</code> is describing the source code, and
<code>/community</code> different ways to contribute, <code>/code</code> should
link to the <code>/community</code> page and vice versa.</p>
<ul>
-<li>Make sure the page has a short, neutral and sensible URI</li>
-<li>e.g. <code>community/lists</code> rather than
<del><code>the%20taverna%20community/contact-us-2</code></del></li>
-<li>Make sure the page is linked from/to relevant existing Apache Taverna
pages (not just the hierarchical parent)</li>
-<li>For example, if <code>/code</code> is describing the source code, and
<code>/community</code> different ways to contribute, <code>/code</code> should
link to the <code>/community</code> page and vice versa.</li>
-<li>Ensure the page is included in the <a
href="https://github.com/apache/incubator-taverna-site/blob/trunk/templates/navbar.html";>navigation
menu bar</a> and in the listing of a higher-level page.</li>
+<li><strong>Include the page in the <a
href="https://github.com/apache/incubator-taverna-site/blob/trunk/templates/navbar.html";>navigation
menu bar</a></strong> and in the listing of a higher-level page.</li>
</ul></div>
</div>
