-
Notifications
You must be signed in to change notification settings - Fork 4
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
Minor: add publishing instructions #11
Conversation
This is currently a manual process. Basic steps are: | ||
|
||
#### Check out `main` and build site |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Filed #13
# copy content built from _site directory | ||
cp -R ../datafusion-site/_site/* . | ||
git commit -a -m 'Publish blog content' |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in #14
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm thanks @alamb
Implement fix found by @comphead in #11 (comment)
Implement fix found by @comphead in #11 (comment)
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