commit | a63941c50ec6aa8481f514858aa9565900679149 | [log] [tgz] |
---|---|---|
author | Kevin Gurney <kgurney@mathworks.com> | Tue Feb 28 19:08:40 2023 -0500 |
committer | GitHub <noreply@github.com> | Wed Mar 01 09:08:40 2023 +0900 |
tree | 6ed3c08ee594896144b7422a39b412ccd7eef2b3 | |
parent | 26c92c9319574c0f2a3cb6f0a6596ee912569851 [diff] |
GH-20161: [Website] Remove mentions of master branch from Apache Arrow website content (#324) # Overview As part of apache/arrow#31142 and in response to the [recent rename of the `apache/arrow-site` repository default branch to `main`](https://issues.apache.org/jira/browse/INFRA-24242), this pull request removes mentions of the "master" branch from the Apache Arrow website content. # Qualification To qualify these changes, I: 1. Performed a local build and preview of the website using `bundle exec rake` and manually verified that all the links are still working. # Future Directions 1. There are still some remaining tasks listed in apache/arrow#31142 related to the renaming of the default branch of the `apache/arrow` repo (and related repositories) to `main`. # Notes **Note**: I left the mentions of "master" in the `_release` and `_posts` directory unmodified. As described in https://github.com/apache/arrow/issues/20161#issuecomment-1442307810, it's unclear whether it makes sense to change these uses since these are referring to a past state of the repository. If the community would prefer that we also removes mentions of "master" from these directories, I would be more than happy to do so. Closes apache/arrow#20161.
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 non-EOL-ed Ruby installed, run the following commands to install Jekyll.
gem install bundler
bundle install
We also need Node.JS to use webpack for maintaining dependent JavaScript and CSS libraries.
We can install webpack and dependent JavaScript and CSS libraries automatically by following command lines to preview or build the site. So we just need to install Node.JS here.
Run the following and open http://localhost:4000/ to preview generated site locally:
bundle exec rake
On commits to the main
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.
FYI: We can also generate the site for https://arrow.apache.org/ to _site/
locally by the following command line:
JEKYLL_ENV=production bundle exec rake generate
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.
If you don't wish to change or install ruby
and nodejs
locally, you can use docker to build and preview the site with a command like:
docker run -v `pwd`:/arrow-site -p 4000:4000 -it ruby bash cd arrow-site apt-get update apt-get install -y npm gem install bundler bundle install # Serve using local container address bundle exec rake HOST=0.0.0.0
Then open http://locahost:4000 locally