airavata-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sma...@apache.org
Subject svn commit: r1139836 - in /incubator/airavata/site/trunk/content/airavata: docs/ docs/governance/ images/
Date Sun, 26 Jun 2011 16:59:16 GMT
Author: smarru
Date: Sun Jun 26 16:59:15 2011
New Revision: 1139836

URL: http://svn.apache.org/viewvc?rev=1139836&view=rev
Log:
adding logos and governance templates

Added:
    incubator/airavata/site/trunk/content/airavata/docs/
    incubator/airavata/site/trunk/content/airavata/docs/edit-cms-website.mdtext
    incubator/airavata/site/trunk/content/airavata/docs/governance/
    incubator/airavata/site/trunk/content/airavata/docs/governance/consensusBuilding.mdtext
    incubator/airavata/site/trunk/content/airavata/docs/governance/lazyConsensus.mdtext
    incubator/airavata/site/trunk/content/airavata/docs/governance/voting.mdtext
    incubator/airavata/site/trunk/content/airavata/images/airavata-logo.png   (with props)
    incubator/airavata/site/trunk/content/airavata/images/airavata-text.png   (with props)

Added: incubator/airavata/site/trunk/content/airavata/docs/edit-cms-website.mdtext
URL: http://svn.apache.org/viewvc/incubator/airavata/site/trunk/content/airavata/docs/edit-cms-website.mdtext?rev=1139836&view=auto
==============================================================================
--- incubator/airavata/site/trunk/content/airavata/docs/edit-cms-website.mdtext (added)
+++ incubator/airavata/site/trunk/content/airavata/docs/edit-cms-website.mdtext Sun Jun 26
16:59:15 2011
@@ -0,0 +1,124 @@
+Title:     How to edit the Aiaravata website
+Notice:    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.
+
+This HowTo documentation will show the needed steps to edit the Airavata
+website. This includes creation of new pages, modification, and deletion - for files
+and sub-directories.
+
+## How it works in general
+
+The website is hosted in a Content Management System (CMS). You will not edit the
+HTML pages directly. The actual edit is splittup in 2 parts:
+
+ 1. First you edit the content which is provided as [Markdown text][1] (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).
+
+ 2. 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).
+
+## What do you prefer: Working via commandline or in the browser?
+
+### Via commandline
+
+It is assumed that you have already checked out the code from the SVN repository
+(https://svn.apache.org/repos/asf/incubator/airavata/site).
+
+Edit the file via your favorite editor like vi and finally commit via SVN:
+
+    vi myfile.mdtext
+    svn ci -m "My log message" myfile.mdtext
+
+Now wait a few seconds so that the entire website can be rebuilt. Then:
+
+    curl -sL http://s.apache.org/cms-cli | perl
+
+If this does not work on your local machine just do it on "people.apache.org" by
+executing this:
+
+    ssh -t <user>@people.apache.org publish.pl airavata <your Apache ID>
+
+### Editing in the browser
+
+#### Prerequisites
+
+##### Browser bookmark
+
+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 [here][2]).
+
+[Add this link as bookmark][3]
+
+##### Apache ID
+
+Furthermore, you need an Apache ID to authenticate to the system.
+
+#### Starting
+
+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.
+
+#### Edit an existing webpage
+
+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.
+
+Now you should see a new webpage with a 4 fields:
+
+ 1. Upper left is the inline editor for text in markdown syntax.
+ 2. Upper right shows the written text as a permanent preview or as HTML source code.
+ 3. Below the editor you can enter a log message.
+ 4. Enter a general header text, e.g., the license of the entered text.
+
+When you have finished writing your text, check the "Log message" box, enter a
+commit message and click on [Submit].
+
+#### Create a new webpage
+
+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).
+
+#### Create new subdirectory
+
+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 "/"!
+
+#### Delete a webpage or subdirectory
+
+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].
+
+#### How to put into production?
+
+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 th webpage. Enter a commit message on click on [Submit].
+
+### Links
+
+[CMS Documentation Reference][4]
+
+  [1]:  http://en.wikipedia.org/wiki/Markdown
+  [2]:  https://cms.apache.org/#bookmark
+  [3]:  javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))
+  [4]:  http://www.apache.org/dev/cmsref.html

Added: incubator/airavata/site/trunk/content/airavata/docs/governance/consensusBuilding.mdtext
URL: http://svn.apache.org/viewvc/incubator/airavata/site/trunk/content/airavata/docs/governance/consensusBuilding.mdtext?rev=1139836&view=auto
==============================================================================
--- incubator/airavata/site/trunk/content/airavata/docs/governance/consensusBuilding.mdtext
(added)
+++ incubator/airavata/site/trunk/content/airavata/docs/governance/consensusBuilding.mdtext
Sun Jun 26 16:59:15 2011
@@ -0,0 +1,66 @@
+Title:     Consensus Building
+Notice:    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.
+
+In some cases there is no obvious path to take, or you might be a new community, 
+or a new member of an existing community. In these cases people will often 
+need to build consensus by making proposals and eliciting responses.
+
+We want to avoid unnecessary discussion and the creation of significant
+amounts of unnecessary mail that everyone in the community needs to read. 
+That is not to say that we want to avoid constructive discussion. This is 
+the lifeblood of a successful project. However, many ASF projects adopt a 
+shorthand notation for showing support, or otherwise, for a proposal.
+
+## Expressing support (or otherwise)
+
+The notation used is "+1", "-1" and "0". It's also common to see "+0" and "-0".
+
+So, what do these notations mean?
+
+  - +1 means "I agree with this and will help make it happen"
+  - +0 means "I agree with this but probably won't make it happen, so my 
+opinion is not that important"
+  - -0 means "I don't agree with this, but I'm offering no alternative so 
+my opinion is not that important"
+  - -1 means "I don't agree and I am offering an alternative that I am able 
+to help implement"
+
+Many people will use fractions to indicate the strength of their feelings,
+ e.g. "+0.5". Some will even indicate this is a "no brainer" with something 
+like "+1000".
+
+The important thing is that this is not an exact science. It's just a shorthand 
+way of communicating strength of feeling.
+
+## Consensus Building is Not Voting
+
+The confusing thing about this notation is that it is the same notation
+used in a formal vote. Knowing when something is a vote and when it is a 
+preference is important. It's easy to tell though, if the subject does not have 
+"[Vote]" at the start then it's just an opinion. We try not to call votes,
+consensus building is much more inclusive.
+
+The reasons for this notation being common is 
+that when someone wants to summarise a discussion thread they can mentally 
+add up the strength of feeling of the community and decide if there is consensus
+or not.
+
+Once there is a clear consensus members of the community can proceed with 
+the work under the [lazy consensus][1] model.
+
+  [1]: /airavata/docs/governance/lazyConsensus.html
\ No newline at end of file

Added: incubator/airavata/site/trunk/content/airavata/docs/governance/lazyConsensus.mdtext
URL: http://svn.apache.org/viewvc/incubator/airavata/site/trunk/content/airavata/docs/governance/lazyConsensus.mdtext?rev=1139836&view=auto
==============================================================================
--- incubator/airavata/site/trunk/content/airavata/docs/governance/lazyConsensus.mdtext (added)
+++ incubator/airavata/site/trunk/content/airavata/docs/governance/lazyConsensus.mdtext Sun
Jun 26 16:59:15 2011
@@ -0,0 +1,71 @@
+Title:     Lazy Consensus
+Notice:    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.
+
+The concept of "Lazy Consensus" is very important in our project. Lazy
+Consensus means that when you are convinced that you know what the community
+would like to see happen you can simply assume that you already have consensus
+and get on with the work. You don't have to insist people discuss and/or
+approve your plan, and you certainly don't need to call a vote to get approval.
+You just assume you have the community's support unless someone says otherwise.
+
+We have a time machine (Subversion), this means that as long as you commit 
+(or submit patches) early and often the community has plenty of opportunity 
+to indicate disapproval. If you believe the community will support your action
+you can operate on lazy consensus as long as you are prepared to roll back 
+any work should a valid objection is raised.
+
+## Avoiding Unnecessary Discussion
+
+The key thing about lazy consensus is that it's easier for people to agree,
+by doing nothing, than it is to object, which requires an
+alternative to be proposed. This has two effects, firstly people are less 
+likely to object for the sake of it and secondly it cuts down on the amount 
+of unnecessary mail traffic and discussion.
+
+Lazy consensus means we can avoid waiting for a community based decision 
+before proceeding. However, it does require everyone who cares for the health
+of the project to watch what is happening, as it is happening. Objecting too 
+far down the road will cause upset, but objecting (or asking for clarification 
+of intent) early is likely to be greeted with relief that someone is watching
+and cares.
+
+## Stating Lazy Consensus
+
+Sometimes a member of the community will believe a specific action is the correct 
+one for the community but are not sure enough to proceed with the work under the 
+lazy consensus model. In these circumstances they can state Lazy Consensus is in 
+operation.
+
+What this means is that they make a proposal and state that they will start 
+implementing it in 72 hours unless someone objects. 72 hours is chosen because
+it accounts for different timezones and non-apache commitments.
+
+In this approach the original proposal is not insisting that there is a discussion
+around their proposal, nor are they requesting that the community explicitly 
+supports their actions. However, this differs from assuming lazy consensus 
+since it allows space and time to [express support or objections][1] and corrections to 
+the proposal before work begins. 
+
+## Silence is consent
+
+People may choose to indicate their support for the actions taken with a +1 
+mail - quick and easy to read and reassuring for the implementer. However, 
+remember, in a lazy consensus world silence is the equivalent to support. This
+can take some time to get used to.
+
+  [1]: /openofficeorg/docs/governance/consensusBuilding.html
\ No newline at end of file

Added: incubator/airavata/site/trunk/content/airavata/docs/governance/voting.mdtext
URL: http://svn.apache.org/viewvc/incubator/airavata/site/trunk/content/airavata/docs/governance/voting.mdtext?rev=1139836&view=auto
==============================================================================
--- incubator/airavata/site/trunk/content/airavata/docs/governance/voting.mdtext (added)
+++ incubator/airavata/site/trunk/content/airavata/docs/governance/voting.mdtext Sun Jun 26
16:59:15 2011
@@ -0,0 +1,112 @@
+Title:     Voting
+Notice:    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.
+
+Occasionally a "feel" for consensus is not enough. Sometimes we need to have a
+measurable consensus. For example, when voting in new committers or to approve a
+release. 
+
+## Preparing for a Vote
+
+Before calling a vote it is important to ensure that the community is given time to
+discuss the upcoming vote. This will be done by posting an email to the list
+indicating the intention to call a vote and the options available. By the time a
+vote is called there should already be [consensus in the community][1]. The vote 
+itself is, normally, a formality.
+
+## Calling a Vote
+
+Once it is time to call the vote a mail is posted with a subject starting with
+"[VOTE]". This enables the community members to ensure they do not miss an important
+vote thread. It also indicates that this is not consensus building but a formal
+vote. The initiator is responsible for the vote. That means also to count the votes
+and present the results. Everyone has 1 vote.
+
+### Casting Your Vote
+
+The notation used in voting is:
+
++1 (means I vote positive)
+   You can say why you vote positive but it's not a must-have.
+
+ 0 (means I have no strong opinion, aka abstention)
+
+-1 (means I vote negative because of the following reason)
+   Yes, you must support your objection and provide an alternative course of action
+   that you are willing and able to implement (where appropriate).
+
+#### Example for a vote mail:
+
+    Address: private@
+    Subject: [VOTE] John Doe should become a regular committer
+    
+    Text:
+    "I would like to propose to vote in John Doe as committer. John has showed in
+    the last months that he has the skills and oversight for improving things (think
+    about the last UI change of the "Find" dialog)."
+    
+    +1 (means I vote for John)
+     0 (means I'm not for John but also not against to vote him in)
+    -1 (means I'm not for John because of the following reason(s):
+    
+    Voting time frame is finished 72 hours from now until June 30, 12:00 PM UTC.
+
+#### Example for a reply mail:
+
+    Text:
+    +1
+    
+    I like his work and want him to stay and to go on with his good improvements.
+
+
+#### Example for a result mail:
+
+    Subject: [VOTE][RESULTS] John Doe should become a regular committer
+    
+    Text:
+    Vote started Thu, Jun 27, 2011 at 12:00 PM UTC, voting is now closed.
+    
+    Voting results:
+    
+    --- Numbers ---
+    
+    +1: 12
+     0: 0
+    -1: 0
+    
+    --- Details ---
+    
+    +1 John Low
+    +1 Marc
+    +1 David
+    +1 Robert
+    +1 Steve
+    +1 Chris
+    +1 Stefan
+    +1 Andrew
+    +1 Dennis
+    +1 Karl
+    +1 Simon
+    +1 Greg
+
+[See here for more information][2] <br>
+[See here for more mail templates][3]
+
+
+  [1]: http://incubator.apache.org/openofficeorg/docs/governance/consensusBuilding.html
+  [2]: http://incubator.apache.org/rave/docs/governance/voting.html
+  [3]: http://community.apache.org/newcommitter.html

Added: incubator/airavata/site/trunk/content/airavata/images/airavata-logo.png
URL: http://svn.apache.org/viewvc/incubator/airavata/site/trunk/content/airavata/images/airavata-logo.png?rev=1139836&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/airavata/site/trunk/content/airavata/images/airavata-logo.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: incubator/airavata/site/trunk/content/airavata/images/airavata-text.png
URL: http://svn.apache.org/viewvc/incubator/airavata/site/trunk/content/airavata/images/airavata-text.png?rev=1139836&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/airavata/site/trunk/content/airavata/images/airavata-text.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream



Mime
View raw message