Skip to content

Minor: Add instructions for building with docker #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Apache DataFusion Blog Content

This repository contains the Apache DataFusion blog content.
This repository contains the Apache DataFusion blog at https://datafusion.apache.org/blog/

## Setup for Mac

Expand Down Expand Up @@ -30,13 +30,28 @@ Should be `ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [arm64-darwin23]` or
gem install jekyll bundler
```

## Preview site locally
### Preview site locally

```shell
cd site
bundle exec jekyll serve
```

## Setup for Docker

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:

```shell
docker run -v `pwd`:/datafusion-site -p 4000:4000 -it ruby bash
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These instructions are adapted from https://github.com/apache/arrow-site

cd datafusion-site
gem install jekyll bundler
bundle install
# Serve using local container address
bundle exec jekyll serve --host 0.0.0.0
```

Then open http://localhost:4000/blog/ to see the blog locally

## Publish site

TBD, but create the html with `bundle exec jekyll build` then check the content into `asf-site` branch