You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2024/07/24 10:43:48 UTC
[PR] Minor: add publishing instructions [datafusion-site]
alamb opened a new pull request, #11:
URL: https://github.com/apache/datafusion-site/pull/11
As part of https://github.com/apache/datafusion-site/pull/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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Minor: add publishing instructions [datafusion-site]
Posted by "phillipleblanc (via GitHub)" <gi...@apache.org>.
phillipleblanc commented on code in PR #11:
URL: https://github.com/apache/datafusion-site/pull/11#discussion_r1689619299
##########
README.md:
##########
@@ -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
\ No newline at end of file
+This is currently a manual process. Basic steps are:
+
+#### Check out `main` and build site
Review Comment:
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.
[our workflow]: https://github.com/spiceai/docs/blob/trunk/.github/workflows/build_and_publish.yml
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Minor: add publishing instructions [datafusion-site]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #11:
URL: https://github.com/apache/datafusion-site/pull/11#discussion_r1690116374
##########
README.md:
##########
@@ -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
\ No newline at end of file
+This is currently a manual process. Basic steps are:
+
+#### Check out `main` and build site
+```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'
Review Comment:
in https://github.com/apache/datafusion-site/pull/14
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Minor: add publishing instructions [datafusion-site]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #11:
URL: https://github.com/apache/datafusion-site/pull/11
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Minor: add publishing instructions [datafusion-site]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #11:
URL: https://github.com/apache/datafusion-site/pull/11#discussion_r1690113764
##########
README.md:
##########
@@ -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
\ No newline at end of file
+This is currently a manual process. Basic steps are:
+
+#### Check out `main` and build site
Review Comment:
Filed https://github.com/apache/datafusion-site/issues/13
##########
README.md:
##########
@@ -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
\ No newline at end of file
+This is currently a manual process. Basic steps are:
+
+#### Check out `main` and build site
+```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'
Review Comment:
Yes, good call -- will fix
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Minor: add publishing instructions [datafusion-site]
Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead commented on code in PR #11:
URL: https://github.com/apache/datafusion-site/pull/11#discussion_r1690000925
##########
README.md:
##########
@@ -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
\ No newline at end of file
+This is currently a manual process. Basic steps are:
+
+#### Check out `main` and build site
+```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'
Review Comment:
if we do a commit should it be followed by push?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Minor: add publishing instructions [datafusion-site]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #11:
URL: https://github.com/apache/datafusion-site/pull/11#discussion_r1689928632
##########
README.md:
##########
@@ -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
\ No newline at end of file
+This is currently a manual process. Basic steps are:
+
+#### Check out `main` and build site
Review Comment:
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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org