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/helix.git
cd 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 guidelines apply, including code review and submitting patches.

If you're a Helix committer, you can run deploySite.sh to go live.

Back to top

Reflow Maven skin by Andrius Velykis.

Apache Helix, Apache, the Apache feather logo, and the Apache Helix project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Privacy Policy