commit | 308b05f3f967214692c49a98ede771ad731d1f20 | [log] [tgz] |
---|---|---|
author | Wes McKinney <wesm+git@apache.org> | Tue Oct 15 09:32:34 2019 -0500 |
committer | Wes McKinney <wesm+git@apache.org> | Tue Oct 15 09:32:34 2019 -0500 |
tree | bfc115eb4058ae60c3b2248cc75eec6fa9f9a21f | |
parent | adcf3e551513d56668b93c760448be5ed647af8d [diff] |
ARROW-5971: [Website] Blog post introducing Arrow Flight We will need to make a general documentation "push" on Flight but it will be helpful to have some more general high level content about the motivation for the project and some of the ways to use it. Target publication later this week Closes #35 from wesm/ARROW-5971 and squashes the following commits: edc9825d <Wes McKinney> Comments, links 220c156b <Wes McKinney> Review comments 5ee6b34e <Wes McKinney> Proofread 370fd641 <Wes McKinney> Typo 456bb09a <Wes McKinney> Feedback 016c4127 <Wes McKinney> Finish Flight blog draft 72f17fd3 <Wes McKinney> Draft more acd85944 <Wes McKinney> More on Flight blog post 5736ee87 <Wes McKinney> Flight blog post draft Authored-by: Wes McKinney <wesm+git@apache.org> Signed-off-by: Wes McKinney <wesm+git@apache.org>
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.