commit | eb2feb04e744478939782d7002026009ddb36556 | [log] [tgz] |
---|---|---|
author | Wes McKinney <wesm+git@apache.org> | Wed Jul 25 19:01:28 2018 +0200 |
committer | Korn, Uwe <Uwe.Korn@blue-yonder.com> | Wed Jul 25 19:01:28 2018 +0200 |
tree | 838ab39819a3c443a951243f58b9558f84a5fe7f | |
parent | 5508377ad58ebb29eff0c870a8d23fc397f28aac [diff] |
ARROW-2881: [Website] Add community tab to header, add link and callout to dev wiki Also resolves ARROW-2804 Author: Wes McKinney <wesm+git@apache.org> Closes #2320 from wesm/ARROW-2881 and squashes the following commits: bd6d257c <Wes McKinney> Fix english 9c72510e <Wes McKinney> Add community tab to header, add link and callout to dev wiki
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
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
To update the documentation, run the script ./dev/gen_apidocs.sh
. This script will run the code documentation tools in a fixed environment.
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/
cd ../js npm run doc rsync -r doc/ ../site/asf-site/docs/js
Then add/commit/push from the site/asf-site git checkout.