Skip to content

Conversation

@alamb
Copy link
Contributor

@alamb alamb commented Jul 24, 2024

As part of #6 I had to figure this out, so I wanted to write it down

Eventually it would be nice to automate this process but for now at least we can have it documented

@alamb alamb mentioned this pull request Jul 24, 2024
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

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
Contributor

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

Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

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

lgtm thanks @alamb

@alamb alamb merged commit a8565ed into apache:main Jul 24, 2024
@alamb alamb deleted the alamb/publish_instructions branch July 24, 2024 16:28
alamb added a commit that referenced this pull request Jul 24, 2024
andygrove pushed a commit that referenced this pull request Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants