| commit | 15a0cc97e5d20a08d186ef261351242a8565aa81 | [log] [tgz] |
|---|---|---|
| author | Luciano Resende <lresende@apache.org> | Sat May 28 02:25:22 2016 -0700 |
| committer | Luciano Resende <lresende@apache.org> | Sat May 28 02:25:22 2016 -0700 |
| tree | b109c6e30941edf9cbcd3250d9c2c63ce2af4036 | |
| parent | 0bcc5140c9677bcd74dbd3fe9e108d4f2b399fa2 [diff] |
Update project description
The Apache Bahir website was forked from the Apache Website Template.
The website gets generated using Jekyll.
To use it, copy the site directory into your project. You must also include licensing information from the LICENSE and NOTICE files in your own project.
(In the following instructions we assume that your project is called ‘Apache Foo’; search and replace with your actual project name.)
1. cd site 2. svn co https://svn.apache.org/repos/asf/bahir/site target 3. sudo apt-get install rubygems ruby2.1-dev zlib1g-dev 4. sudo gem install bundler github-pages jekyll 5. bundle install
If your project supports javadoc, you can copy the generated javadoc into svn each time you need to re-generate.
1. cd .. 2. mvn -DskipTests site 3. mv target/site/apidocs site/_site
Before opening a pull request, you can preview your contributions by running from within the directory:
1. bundle exec jekyll serve 2. Open [http://localhost:4000](http://localhost:4000)
1. cd site/_site 2. svn status 3. You'll need to `svn add` any new files 4. svn ci
Within a few minutes, svnpubsub should kick in and you'll be able to see the results at bahir.apache.org.
To add a contributor to the project, or to modify existing contributors, edit site/_data/contributors.yml. The project members list will be re-generated.