Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Minor: add publishing instructions #11

Merged
merged 1 commit into from
Jul 24, 2024
Merged

Minor: add publishing instructions #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 27 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,30 @@ bundle exec jekyll serve

## Publish site

TBD, but create the html with `bundle exec jekyll build` then check the content into `asf-site` branch
This is currently a manual process. Basic steps are:

#### Check out `main` and build site
Copy link
Contributor

Choose a reason for hiding this comment

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

We have had success using the https://github.com/peaceiris/actions-gh-pages action to automate publishing static content into another branch for our docs. It's built for GitHub Pages, but setting publish_branch to asf_site and publish_dir to _site might be enough to make it work for this. Here's our workflow if you want to take a look.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you @phillipleblanc -- the arrow blog has an automated workflow too which I think we could take a friendly look at as well.

https://github.com/apache/arrow-site/blob/main/.github/workflows/deploy.yml

I will file a ticket to track the idea

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Filed #13

```shell
# Check out latest code
git checkout main
git pull
# build site (html is left in _site directory)
bundle exec jekyll build
```

#### Check out `asf-site` and copy content
Checkout a separate copy of `datafusion-site`

```shell
git checkout asf-site
git pull
# create a branch for the publishing
git checkout -b publish_blog
# copy content built from _site directory
cp -R ../datafusion-site/_site/* .
git commit -a -m 'Publish blog content'
Copy link

Choose a reason for hiding this comment

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

if we do a commit should it be followed by push?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, good call -- will fix

Copy link
Contributor Author

Choose a reason for hiding this comment

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

in #14

```

#### Make PR, targeting the `asf-site` branch
For example, see https://github.com/apache/datafusion-site/pull/9