Google Git
Sign in
apache / arrow-site / 2a552c6a76434c4aaca978156faefdfd465cef70
commit2a552c6a76434c4aaca978156faefdfd465cef70[log] [tgz]
authorWes McKinney <wes.mckinney@twosigma.com>Tue Jul 25 10:38:46 2017 -0400
committerWes McKinney <wes.mckinney@twosigma.com>Tue Jul 25 10:38:46 2017 -0400
tree94f45ab185b81a7fc57488438e4b7db1593f1ed9
parent794112d1dd449d5035e97ebb773713ec72b79dfb [diff]
ARROW-1252: [Website] Updates for 0.5.0 and short blog post summarizing the release

Also updated the CHANGELOG.md

Author: Wes McKinney <wes.mckinney@twosigma.com>

Closes #885 from wesm/ARROW-1252 and squashes the following commits:

e603f388 [Wes McKinney] Fix up markdown formatting of underscores
797215b2 [Wes McKinney] Release announcement blog post
3babc7b4 [Wes McKinney] Add release page
3fd41e11 [Wes McKinney] First cut revising install page
b8416ee5 [Wes McKinney] Add changelog to CHANGELOG.md
3f9dec05 [Wes McKinney] Start on 0.5.0 website updates
5 files changed
tree: 94f45ab185b81a7fc57488438e4b7db1593f1ed9
  1. _data/
  2. _docs/
  3. _includes/
  4. _layouts/
  5. _posts/
  6. _release/
  7. _sass/
  8. css/
  9. img/
  10. scripts/
  11. .gitignore
  12. _config.yml
  13. blog.html
  14. committers.html
  15. Gemfile
  16. index.html
  17. install.md
  18. README.md
README.md

Apache Arrow Website

Development instructions

If you are planning to publish the website, you must first clone the arrow-site git repository:

git clone --branch=asf-site https://git-wip-us.apache.org/repos/asf/arrow-site.git asf-site

Now, with Ruby >= 2.1 installed, run:

gem install jekyll bundler
bundle install

# This imports the format Markdown documents so they will be rendered
scripts/sync_format_docs.sh

bundle exec jekyll serve

Publishing

After following the above instructions the base site/ directory, run:

bundle exec jekyll build
rsync -r build/ asf-site/
cd asf-site
git status

Now git add any new files, then commit everything, and push:

git push

Updating Code Documentation

Java

cd ../java
mvn install
mvn site
rsync -r target/site/apidocs/ ../site/asf-site/docs/java/

C++

cd ../cpp/apidoc
doxygen Doxyfile
rsync -r html/ ../../site/asf-site/docs/cpp

Python

First, build PyArrow with all optional extensions (Apache Parquet).

cd ../python
python setup.py build_ext --inplace --with-parquet
python setup.py build_sphinx -s doc/source
rsync -r doc/_build/html/ ../site/asf-site/docs/python/

C (GLib)

First, build Apache Arrow C++ and Apache Arrow GLib.

mkdir -p ../cpp/build
cd ../cpp/build
cmake .. -DCMAKE_BUILD_TYPE=debug
make
cd ../../c_glib
./autogen.sh
./configure \
  --with-arrow-cpp-build-dir=$PWD/../cpp/build \
  --with-arrow-cpp-build-type=debug \
  --enable-gtk-doc
LD_LIBRARY_PATH=$PWD/../cpp/build/debug make GTK_DOC_V_XREF=": "
rsync -r doc/reference/html/ ../site/asf-site/docs/c_glib/

Then add/commit/push from the site/asf-site git checkout.