Google Git
Sign in
apache / arrow-site / dea4fb2e708151fc3f9ef07f44f6520770dc283b
commitdea4fb2e708151fc3f9ef07f44f6520770dc283b[log] [tgz]
authorNeal Richardson <neal.p.richardson@gmail.com>Wed Jun 26 23:35:30 2019 -0500
committerWes McKinney <wesm+git@apache.org>Wed Jun 26 23:35:30 2019 -0500
tree1fea5c821ecf1e087c791e38b2f7f78f773214ec
parentbf6c1845309dc5c1ae6f8775034bb5f16514e6dc [diff]
ARROW-5257: [Website] Update site to use "official" Apache Arrow logo, add clearly marked links to logo

Header uses an inverted (white print with transparent background) version of the logo because the header has a dark background.

<img width="400" alt="powered-by-header" src="https://user-images.githubusercontent.com/2975928/60135888-9ccadc00-9757-11e9-8469-18f9d09e0387.png">

The proper black logo (with transparent background) is shown on the "powered by" page, which recommends folks to use that logo when referring to Arrow.

<img width="400" alt="powered-by-screenshot" src="https://user-images.githubusercontent.com/2975928/60135811-65f4c600-9757-11e9-8327-692ddbabbace.png">

The header logo is reduced in size to 300px in height, and then the img tag further reduces display to 60px. That combination got the sharpest rendering of the image with a reasonable file size. As discussed on the jira ticket, a better solution would be to use svg, but this works for now.

I also reorganized the powered-by page, putting the projects first and the trademark language last. Given the intended audience of this page, that seems like a more natural order.

Author: Neal Richardson <neal.p.richardson@gmail.com>

Closes #4696 from nealrichardson/correct-logo and squashes the following commits:

481c19149 <Neal Richardson> Add François to committers
cca872150 <Neal Richardson> Move trademark back up
53cd0c406 <Neal Richardson> WIP on getting the right logo
6 files changed
tree: 1fea5c821ecf1e087c791e38b2f7f78f773214ec
  1. _data/
  2. _docs/
  3. _includes/
  4. _layouts/
  5. _posts/
  6. _release/
  7. _sass/
  8. assets/
  9. css/
  10. img/
  11. scripts/
  12. .gitignore
  13. _config.yml
  14. arrow.rdf
  15. blog.html
  16. committers.html
  17. faq.md
  18. Gemfile
  19. index.html
  20. install.md
  21. powered_by.md
  22. README.md
README.md

Apache Arrow Website

Overview

Site content is maintained in the main Arrow repository, mostly in markdown format. Jekyll is used to generate HTML files that can then be committed to the arrow-site repository.

Prerequisites

With Ruby >= 2.1 installed, run the following commands to install Jekyll.

gem install jekyll bundler
bundle install

If you are planning to publish the website, you must clone the arrow-site git repository. Run this command from the site directory so that asf-site is a subdirectory of site.

git clone --branch=asf-site https://github.com/apache/arrow-site.git asf-site

Previewing the site

From the site directory, run the following to generate HTML files and run the web site locally.

bundle exec jekyll serve

Publishing

After following the above instructions, run the following commands from the site directory:

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

Updating Code Documentation

To update the documentation, run the script ./dev/gen_apidocs.sh. This script will run the code documentation tools in a fixed environment.

C (GLib)

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/

Javascript

cd ../js
npm run doc
rsync -r doc/ ../site/asf-site/docs/js

Then add/commit/push from the site/asf-site git checkout.