Google Git
Sign in
apache / arrow-site / a78bd9ca7176bb102a029e584ce78a2616c05e32
commita78bd9ca7176bb102a029e584ce78a2616c05e32[log] [tgz]
authorRobert Nishihara <robertnishihara@gmail.com>Mon Aug 07 22:50:38 2017 -0400
committerWes McKinney <wes.mckinney@twosigma.com>Mon Aug 07 22:50:38 2017 -0400
tree63e8dfd10e36fa98f507506409bad9662645c455
parenta77430fe55a5c1a6b77a75ce694091c60a8bad79 [diff]
ARROW-1173: [Plasma] Add blog post describing Plasma object store

Author: Robert Nishihara <robertnishihara@gmail.com>

Closes #940 from robertnishihara/plasmablogpost and squashes the following commits:

d7230930 [Robert Nishihara] Update blog post date.
48c9c7b9 [Robert Nishihara] Change speedup after improving baseline.
2ae1d66e [Robert Nishihara] Add blog post describing Plasma object store.
1 file changed
tree: 63e8dfd10e36fa98f507506409bad9662645c455
  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.