| commit | 5a88239c01690888da0c677fcca659ae9f71391d | [log] [tgz] |
|---|---|---|
| author | Neal Richardson <neal.p.richardson@gmail.com> | Sun Oct 06 16:10:31 2019 -0500 |
| committer | Wes McKinney <wesm+git@apache.org> | Sun Oct 06 16:10:31 2019 -0500 |
| tree | 2b9ea7e63ac9420fccd726ac010b8d31b36728e1 | |
| parent | 37a016865583f904bc58255edab964d19af135c3 [diff] |
ARROW-6616: [Website] Release announcement blog post for 0.15 Needs filling in. Any committers should feel free to edit and push to my fork with changes. Closes #27 from nealrichardson/blog-post-0.15 and squashes the following commits: 5dedee7e <Wes McKinney> Finish getting 0.15.0 blog post ready for publication dcd0d55c <Yosuke Shiro> Add Ruby and C GLib notes 8bf9d571 <Kenta Murata> Add C++ Tensor notes 761ad039 <Neal Richardson> Add R notes and note about Parquet C++ improvements e4f238df <Andy Grove> Add Rust notes 8ca655e9 <Antoine Pitrou> Add Flight and Python notes 7799c2ee <Antoine Pitrou> Add Flight notes 857d8a8c <Antoine Pitrou> Add some comments 1a558446 <Neal Richardson> Add java notes from @tianchen92 d519f0de <Neal Richardson> Add start of 0.15 post (and fix link in 0.14 post) ec40d08a <Neal Richardson> Update committers list Lead-authored-by: Neal Richardson <neal.p.richardson@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Co-authored-by: Wes McKinney <wesm+git@apache.org> Co-authored-by: Yosuke Shiro <yosuke.shiro615@gmail.com> Co-authored-by: Kenta Murata <mrkn@mrkn.jp> Co-authored-by: Andy Grove <andygrove73@gmail.com> 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.