You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "martin-g (via GitHub)" <gi...@apache.org> on 2023/03/17 14:20:58 UTC
[GitHub] [arrow-datafusion] martin-g opened a new pull request, #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
martin-g opened a new pull request, #5631:
URL: https://github.com/apache/arrow-datafusion/pull/5631
# Which issue does this PR close?
Closes #5500
# Rationale for this change
Deploy the Datafusion website whenever a change is made in the `docs/` folder.
# What changes are included in this PR?
A new Github Action is introduced that builds the docs and copies them to arrow-site/datafusion
# Are these changes tested?
Yes, I have tested them in my fork.
The only part that is not really tested is the `git push` to arrow-site. But arrow-datafusion-python uses the same [code](https://github.com/apache/arrow-datafusion-python/blob/2bf684e7fe6105ad66260483154b5e944f2c724d/.github/workflows/docs.yaml#L69-L75)
# Are there any user-facing changes?
No
--
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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] kou commented on pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #5631:
URL: https://github.com/apache/arrow-datafusion/pull/5631#issuecomment-1477969817
@martin-g @alamb I've created the orphan `asf-site` branch: https://github.com/apache/arrow-datafusion/tree/asf-site
--
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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] alamb commented on a diff in pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #5631:
URL: https://github.com/apache/arrow-datafusion/pull/5631#discussion_r1140997414
##########
docs/source/_templates/docs-sidebar.html:
##########
@@ -1,7 +1,4 @@
-<a class="navbar-brand" href="{{ pathto(master_doc) }}">
Review Comment:
@andygrove or @houqp do you remember what this is used for or if it is critical to 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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] martin-g commented on pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g commented on PR #5631:
URL: https://github.com/apache/arrow-datafusion/pull/5631#issuecomment-1477786931
@alamb (or anyone else with permissions) Please create a branch for the site, e.g. `asf-site` in `arrow-datafusion` repo.
You could remove all files and folders in it. Or leave that to the Github Action workflow. It will remove all old content before copying the newly generated HTMLs, as in [arrow-datafusion-python](https://github.com/apache/arrow-datafusion-python/blob/2bf684e7fe6105ad66260483154b5e944f2c724d/.github/workflows/docs.yaml#L64-L65)
--
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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] martin-g commented on pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g commented on PR #5631:
URL: https://github.com/apache/arrow-datafusion/pull/5631#issuecomment-1473919524
CC @kou @andygrove
--
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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] martin-g closed pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g closed pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
URL: https://github.com/apache/arrow-datafusion/pull/5631
--
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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] alamb commented on a diff in pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #5631:
URL: https://github.com/apache/arrow-datafusion/pull/5631#discussion_r1140997556
##########
docs/source/_templates/docs-sidebar.html:
##########
@@ -1,7 +1,4 @@
-<a class="navbar-brand" href="{{ pathto(master_doc) }}">
Review Comment:
(I personally think that as long as this removal doesn't render the docs inoperable, it would be fine to remove this code to get the docs publishing and fix it afterwards)
--
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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] alamb commented on pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #5631:
URL: https://github.com/apache/arrow-datafusion/pull/5631#issuecomment-1474817659
> It is easy for me to make the change if the team prefers this way!
I think this would be a great idea. Thank you @martin-g and @kou -- getting the docs building regularly is so exciting!
--
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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] martin-g commented on a diff in pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g commented on code in PR #5631:
URL: https://github.com/apache/arrow-datafusion/pull/5631#discussion_r1140302457
##########
docs/source/_templates/docs-sidebar.html:
##########
@@ -1,7 +1,4 @@
-<a class="navbar-brand" href="{{ pathto(master_doc) }}">
Review Comment:
Converted the PR to a Draft one because of this change.
See https://github.com/apache/arrow-datafusion/issues/5500#issuecomment-1473877086
--
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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] kou commented on pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #5631:
URL: https://github.com/apache/arrow-datafusion/pull/5631#issuecomment-1474460698
How about using `publish.subdir` in `.asf.yaml` like ADBC instead of pushing to `apache/arrow-site`?
https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features#Git.asf.yamlfeatures-Specifyingasub-directorytopublishto
If we use `publish.subdir`, we can publish the DataFusion docs to https://arrow.apache.org/datafusion/ by pushing to the `asf-site` branch in `apache/arrow-datafusion` (not `apache/arrow-site`).
See also:
* ADBC's `.asf.yaml`: https://github.com/apache/arrow-adbc/blob/main/.asf.yaml#L35-L37
* ADBC's GitHub Actions: https://github.com/apache/arrow-adbc/blob/main/.github/workflows/nightly-website.yml (filename includes "nightly" but it's not nightly...)
* ADBC's `asf-site` branch: https://github.com/apache/arrow-adbc/tree/asf-site
* ADBC's site: https://arrow.apache.org/adbc/
--
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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] kou commented on pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #5631:
URL: https://github.com/apache/arrow-datafusion/pull/5631#issuecomment-1474462135
We used `publish.subdir` for arrow-datafusion-python too.
--
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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-datafusion] martin-g commented on pull request #5631: Fixes #5500 - Add a Github Actions workflow that builds the docs
Posted by "martin-g (via GitHub)" <gi...@apache.org>.
martin-g commented on PR #5631:
URL: https://github.com/apache/arrow-datafusion/pull/5631#issuecomment-1474816710
It is easy for me to make the change if the team prefers this way!
On Sat, Mar 18, 2023, 00:22 Sutou Kouhei ***@***.***> wrote:
> We used publish.subdir for arrow-datafusion-python too.
>
> —
> Reply to this email directly, view it on GitHub
> <https://github.com/apache/arrow-datafusion/pull/5631#issuecomment-1474462135>,
> or unsubscribe
> <https://github.com/notifications/unsubscribe-auth/AABYUQVQE4W4BYIP67IQVMLW4TP2BANCNFSM6AAAAAAV6TBM2A>
> .
> You are receiving this because you authored the thread.Message ID:
> ***@***.***>
>
--
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@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org