Return-Path: X-Original-To: apmail-helix-commits-archive@minotaur.apache.org Delivered-To: apmail-helix-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 9DEF310D76 for ; Fri, 3 Jan 2014 00:08:46 +0000 (UTC) Received: (qmail 94843 invoked by uid 500); 3 Jan 2014 00:08:46 -0000 Delivered-To: apmail-helix-commits-archive@helix.apache.org Received: (qmail 94808 invoked by uid 500); 3 Jan 2014 00:08:46 -0000 Mailing-List: contact commits-help@helix.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@helix.incubator.apache.org Delivered-To: mailing list commits@helix.incubator.apache.org Received: (qmail 94801 invoked by uid 99); 3 Jan 2014 00:08:46 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 03 Jan 2014 00:08:46 +0000 X-ASF-Spam-Status: No, hits=-2000.4 required=5.0 tests=ALL_TRUSTED,RP_MATCHES_RCVD X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO mail.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with SMTP; Fri, 03 Jan 2014 00:08:43 +0000 Received: (qmail 94564 invoked by uid 99); 3 Jan 2014 00:08:21 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 03 Jan 2014 00:08:21 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 5E670915049; Fri, 3 Jan 2014 00:08:21 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: kanak@apache.org To: commits@helix.incubator.apache.org Message-Id: X-Mailer: ASF-Git Admin Mailer Subject: git commit: [HELIX-348] Add a guide to improving the website Date: Fri, 3 Jan 2014 00:08:21 +0000 (UTC) X-Virus-Checked: Checked by ClamAV on apache.org 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 Authored: Thu Jan 2 16:07:50 2014 -0800 Committer: Kanak Biscuitwala 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 @@ + + +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 @@ - + @@ -87,6 +87,7 @@ +