commit | 49964cb9ec1ce5853d5128e95c46938a5ff9b3e1 | [log] [tgz] |
---|---|---|
author | Renato Marroquin <marenato@inf.ethz.ch> | Sat Aug 25 20:44:31 2018 -0400 |
committer | Wes McKinney <wesm+git@apache.org> | Sat Aug 25 20:44:31 2018 -0400 |
tree | 9eba936bc16093124984311adf0e1354582147d3 | |
parent | eed0fe1aa16d53211379da5159efc6e818cd49e6 [diff] |
ARROW-3114: [Website] Add information about user@ mailing list to website / Community page This addresses https://issues.apache.org/jira/browse/ARROW-3114 Author: Renato Marroquin <marenato@inf.ethz.ch> Closes #2473 from renato2099/ARROW-3114 and squashes the following commits: 22d206ef <Renato Marroquin> ARROW-3114: Add information about user@ mailing list to website / Community page
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.