Skip to content

Conversation

@martin-g
Copy link
Member

@martin-g martin-g commented Mar 21, 2023

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 asf-site branch

Are these changes tested?

Yes, I have tested them in my fork.

Are there any user-facing changes?

No

Signed-off-by: Martin Tzvetanov Grigorov <mgrigorov@apache.org>
@github-actions github-actions bot added the development-process Related to development process of DataFusion label Mar 21, 2023
@martin-g
Copy link
Member Author

This PR is a follow up of #5631

Last successful run of the new docs GHA workflow could be seen at https://github.com/martin-g/arrow-datafusion/actions/runs/4479933269/jobs/7874551780
Content of asf-site branch in my fork: https://github.com/martin-g/arrow-datafusion/tree/asf-site

@martin-g
Copy link
Member Author

TODOs for the Datafusion committers:

  1. create asf-site branch in arrow-datafusion repo
  2. delete the datafusion folder in arrow-site repo

@martin-g
Copy link
Member Author

CC @kou @alamb

@kou
Copy link
Member

kou commented Mar 21, 2023

  1. create asf-site branch in arrow-datafusion repo

Done.

martin-g and others added 3 commits March 21, 2023 19:22
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Martin Tzvetanov Grigorov <mgrigorov@apache.org>
@alamb
Copy link
Contributor

alamb commented Mar 21, 2023

I tested this PR out in my fork and it works great! Thank you @martin-g

Here https://github.com/alamb/arrow-datafusion/tree/asf-site

What are the next steps after this PR to actually get this site served?

On my fork I configured github pages:

Screenshot 2023-03-21 at 4 42 13 PM

And it published https://github.com/alamb/arrow-datafusion/actions/runs/4483635485 which is cool

But the site looks pretty bad https://alamb.github.io/arrow-datafusion

Screenshot 2023-03-21 at 5 00 56 PM

@alamb
Copy link
Contributor

alamb commented Mar 21, 2023

  1. delete the datafusion folder in arrow-site repo

Here is a PR to do this apache/arrow-site#336

Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

Seems like a step forward to me 👍

It would be nice to sort out how this content will be hosted (though maybe I just don't understand how the process works)

Thanks again @martin-g and @kou for your work in this area

@alamb
Copy link
Contributor

alamb commented Mar 21, 2023

However, when I check out the site locally and open it, it works great 👍

So I think that means the issue is with how github pages is publishing it

Screenshot 2023-03-21 at 5 10 53 PM

@kou
Copy link
Member

kou commented Mar 21, 2023

We need to add .nojekyll to the asf-site like https://github.com/apache/arrow-site/blob/main/.github/workflows/deploy.yml#L112 to use GitHub Pages for preview.
If we don't have .nojekyll, our asf-site contents are processed by Jekyll. Jekyll ignores _*. So _static/styles/* aren't published on GitHub Pages.

@kou kou changed the title Fixes #5500 - Add a Github Actions workflow that builds the docs Fixes #5500 - Add a GitHub Actions workflow that builds the docs Mar 21, 2023
Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

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

+1

@kou
Copy link
Member

kou commented Mar 21, 2023

It would be nice to sort out how this content will be hosted (though maybe I just don't understand how the process works)

ASF provides https://arrow.apache.org/ (not GitHub Pages) that serves the contents in https://github.com/apache/arrow-site/tree/asf-site .
With the .asf.yaml configuration in this PR, https://arrow.apache.org/datafusion/ uses https://github.com/apache/arrow-datafusion/tree/asf-site instead of https://github.com/apache/arrow-site/tree/asf-site/datafusion .

Suggested-by @kou at #5670 (comment)

Signed-off-by: Martin Tzvetanov Grigorov <mgrigorov@apache.org>
@alamb
Copy link
Contributor

alamb commented Mar 22, 2023

I tested the latest and greatest code on my fork and it seems to have worked great! https://alamb.github.io/arrow-datafusion/

Thank you so much @martin-g and @kou

Screenshot 2023-03-22 at 6 28 42 AM

I am going to merge this PR and see how it goes!

@alamb alamb merged commit 92c985e into apache:main Mar 22, 2023
@alamb
Copy link
Contributor

alamb commented Mar 22, 2023

I am happy to report that the first run of https://github.com/apache/arrow-datafusion/actions/runs/4488868585/jobs/7893990469 has worked

And the content appears to be on https://github.com/apache/arrow-datafusion/tree/asf-site 👍

I am going to test making changes to the datafusion site and verify they appear on https://arrow.apache.org/datafusion/

@alamb
Copy link
Contributor

alamb commented Mar 22, 2023

My test shows that the process is working : #5500 (comment)

Thanks again @kou and @martin-g -- this is really great.

@alamb
Copy link
Contributor

alamb commented Mar 22, 2023

PR to update release process: #5687

@@ -1,7 +1,4 @@

<a class="navbar-brand" href="{{ pathto(master_doc) }}">
Copy link
Contributor

Choose a reason for hiding this comment

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

Here is a proposal to get the logo back : #5688

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

development-process Related to development process of DataFusion

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automate build and publish of the user guide

3 participants