helix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ka...@apache.org
Subject git commit: [HELIX-348] Add a guide to improving the website
Date Fri, 03 Jan 2014 00:08:21 GMT
Updated Branches:
  refs/heads/master 439125ae3 -> 5db9c6c45


[HELIX-348] Add a guide to improving the website


Project: http://git-wip-us.apache.org/repos/asf/incubator-helix/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-helix/commit/5db9c6c4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-helix/tree/5db9c6c4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-helix/diff/5db9c6c4

Branch: refs/heads/master
Commit: 5db9c6c454c33ebcf011c991920797de5bef8dfd
Parents: 439125a
Author: Kanak Biscuitwala <kanak@apache.org>
Authored: Thu Jan 2 16:07:50 2014 -0800
Committer: Kanak Biscuitwala <kanak@apache.org>
Committed: Thu Jan 2 16:07:50 2014 -0800

----------------------------------------------------------------------
 website/src/site/markdown/involved/building.md  |  8 ++-
 .../src/site/markdown/involved/contribdocs.md   | 66 ++++++++++++++++++++
 website/src/site/site.xml                       |  3 +-
 3 files changed, 74 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/5db9c6c4/website/src/site/markdown/involved/building.md
----------------------------------------------------------------------
diff --git a/website/src/site/markdown/involved/building.md b/website/src/site/markdown/involved/building.md
index ea8c081..96a0fae 100644
--- a/website/src/site/markdown/involved/building.md
+++ b/website/src/site/markdown/involved/building.md
@@ -21,10 +21,14 @@ under the License.
 Building Apache Helix
 --------------
 
-First you need to install Apache Maven.
+First you need to install [Apache Maven](http://maven.apache.org) 2.0.8+.
 
-To install jars locally:
+To install JARs locally:
 
 ```
 mvn clean install (-DskipTests if you don't want to run tests)
 ```
+
+### Contribution Guide
+
+If you are interested in contributing to Helix, [here](https://cwiki.apache.org/confluence/display/HELIX/Contributor+Workflow)
is a guide.

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/5db9c6c4/website/src/site/markdown/involved/contribdocs.md
----------------------------------------------------------------------
diff --git a/website/src/site/markdown/involved/contribdocs.md b/website/src/site/markdown/involved/contribdocs.md
new file mode 100644
index 0000000..80640f8
--- /dev/null
+++ b/website/src/site/markdown/involved/contribdocs.md
@@ -0,0 +1,66 @@
+<!---
+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.
+-->
+
+Improve this Website
+--------------------
+
+Learn something new about Helix that you think would benefit others? The source for this
website is available for you to look at and edit!
+
+### Get the Code
+```
+git clone https://git-wip-us.apache.org/repos/asf/incubator-helix.git
+cd incubator-helix/website
+```
+
+### Make Changes
+
+The website is structured as follows:
+
+```
+website/ -- the root directory for the Helix website
+  src/site -- source files for all the top-level webpages
+  	site.xml -- metadata for the top-level website
+  version-docs/ -- the root directory for the documentation for a given Helix version
+    src/site -- source files for documentation specific to the version
+      site.xml -- metadata for the release documentation
+    pom.xml -- Maven pom for the release documentation package
+  pom.xml -- parent Maven pom for the website
+  deploySite.sh -- script to deploy the website publicly (for committers)
+```
+
+### Build Locally
+
+To build the website, do the following:
+
+```
+mvn site
+mvn site:stage
+```
+
+Then, the entire website will be placed in `target/staging`. If you have Python installed,
this command will start a local web server on port 8000:
+
+```
+pushd target/staging; python -m SimpleHTTPServer; popd
+```
+
+### Submitting Changes
+
+Once satisfied with any new changes to the website, the standard [code contribution](https://cwiki.apache.org/confluence/display/HELIX/Contributor+Workflow)
guidelines apply, including code review and submitting patches.
+
+If you\'re a Helix committer, you can run `deploySite.sh` to go live.

http://git-wip-us.apache.org/repos/asf/incubator-helix/blob/5db9c6c4/website/src/site/site.xml
----------------------------------------------------------------------
diff --git a/website/src/site/site.xml b/website/src/site/site.xml
index 468a5bc..adc9a1e 100644
--- a/website/src/site/site.xml
+++ b/website/src/site/site.xml
@@ -58,7 +58,7 @@
     </breadcrumbs>
 
     <menu name="Learn">
-      <item name="Core concepts" href="./Concepts.html"/>
+      <item name="Core Concepts" href="./Concepts.html"/>
       <item name="Architecture" href="./Architecture.html"/>
       <item name="Publications" href="./Publications.html"/>
       <item name="Client Libraries" href="./ClientLibraries.html"/>
@@ -87,6 +87,7 @@
       <item name="Continuous Integration" href="integration.html"/>
       <item name="Building Guide" href="/involved/building.html"/>
       <item name="Release Guide" href="/releasing.html"/>
+      <item name="Improve this Website" href="/involved/contribdocs.html"/>
     </menu>
 <!--
     <menu ref="reports" inherit="bottom"/>


Mime
View raw message