commit | 2365ba238360c022fff9d32f21984d957696d94b | [log] [tgz] |
---|---|---|
author | Neal Richardson <neal.p.richardson@gmail.com> | Wed Feb 12 08:28:26 2020 -0800 |
committer | GitHub <noreply@github.com> | Wed Feb 12 11:28:26 2020 -0500 |
tree | b6dff7c270329572727a6f5954edc79945c1e33c | |
parent | d622ec2e4955066c274c33f1a98d8a8bd3bf1a88 [diff] |
ARROW-7580: [Website] 0.16 release post (#41) * Create outline for 0.16 release post * Add release notes Add highlights for C++, Python, community discussions. * Add dataset changes * Add Rust notes * Add Ruby and C GLib notes * Add syntax highlighting * update Rust notes * Add some notes, simplify some of hte C++ section for readability * Revise/extend 0.16 blog post * Add some update fo specification and Java * Added a java bug fix bullet point. * add python 2.7 note * Fix typo * Rename file * Edits for publication * More cleanup * Update publication date Co-authored-by: Antoine Pitrou <pitrou@free.fr> Co-authored-by: François Saint-Jacques <fsaintjacques@gmail.com> Co-authored-by: Wakahisa <nevilledips@gmail.com> Co-authored-by: Yosuke Shiro <yosuke.shiro615@gmail.com> Co-authored-by: Wes McKinney <wesm@users.noreply.github.com> Co-authored-by: emkornfield <emkornfield@gmail.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Kenta Murata <mrkn@users.noreply.github.com>
Jekyll is used to generate HTML files from the markdown + templates in this repository. The built version of the site is kept on the asf-site
branch, which gets deployed to https://arrow.apache.org.
To add a blog post, create a new markdown file in the _posts
directory, following the model of existing posts. In the front matter, you should specify an “author”. This should be your Apache ID if you have one, or it can just be your name. To add additional metadata about yourself (GitHub ID, website), add yourself to _data/contributors.yml
. This object is keyed by apacheId
, so use that as the author
in your post. (It doesn't matter if the ID actually exists in the ASF; all metadata is local to this project.)
With Ruby >= 2.1 installed, run the following commands to install Jekyll.
gem install jekyll bundler
bundle install
On some platforms, the Ruby nokogiri
library may fail to build, in such cases the following configuration option may help:
bundle config build.nokogiri --use-system-libraries
nokogiri
depends on the libxml2
and libxslt1
libraries, which can be installed on Debian-like systems with
apt-get install libxml2-dev libxslt1-dev
Run the following to generate HTML files and run the web site locally.
bundle exec jekyll serve
On commits to the master
branch of apache/arrow-site
, the rendered static site will be published to the asf-site
branch using GitHub Actions. On a fork, it will deploy to your gh-pages
branch for deployment via GitHub Pages; this is useful for previewing changes you‘re proposing. To enable this deployment on your fork, you’ll need to sign up for GitHub Actions here.
To update the documentation, you can run the script ./dev/gen_apidocs.sh
in the apache/arrow
repository. This script will run the code documentation tools in a fixed environment.
First, build Apache Arrow C++ and Apache Arrow GLib. This assumes that you have checkouts your forks of arrow
and arrow-site
alongside each other in your file system.
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/ ../../arrow-site/asf-site/docs/c_glib/
cd ../js npm run doc rsync -r doc/ ../../arrow-site/asf-site/docs/js
Then add/commit/push from the asf-site/
git checkout.