Google Git
Sign in
apache / arrow-site / 069636f12ac4b93db2883182dc62c7adef788888
commit069636f12ac4b93db2883182dc62c7adef788888[log] [tgz]
authorWes McKinney <wesm+git@apache.org>Tue Aug 07 09:50:11 2018 -0400
committerWes McKinney <wesm+git@apache.org>Tue Aug 07 09:50:11 2018 -0400
tree30828214cfea8988eb9d2f7658096af29fe5e54c
parenteb2feb04e744478939782d7002026009ddb36556 [diff]
ARROW-3005: [Release] Update website, draft simple release blog post for 0.10.0

The install page is still in need of some updates. We should discuss how to make available the official Linux packages in for use in apt/yum in the future.

Author: Wes McKinney <wesm+git@apache.org>

Closes #2387 from wesm/ARROW-3005 and squashes the following commits:

4ebee208 <Wes McKinney> Escape more things, add link to release index
5c1b7fa6 <Wes McKinney> Address comments. Escape underscores when formatting changelog for website
62ef6bf5 <Wes McKinney> Update website, draft simple release blog post
7 files changed
tree: 30828214cfea8988eb9d2f7658096af29fe5e54c
  1. _data/
  2. _docs/
  3. _includes/
  4. _layouts/
  5. _posts/
  6. _release/
  7. _sass/
  8. assets/
  9. css/
  10. img/
  11. scripts/
  12. .gitignore
  13. _config.yml
  14. blog.html
  15. committers.html
  16. Gemfile
  17. index.html
  18. install.md
  19. powered_by.md
  20. 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:

JEKYLL_ENV=production 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

To update the documentation, run the script ./dev/gen_apidocs.sh. This script will run the code documentation tools in a fixed environment.

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/

Javascript

cd ../js
npm run doc
rsync -r doc/ ../site/asf-site/docs/js

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