Skip to content
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

Update .asf.yaml to publish docs to datafusion.apache.org #10190

Merged
merged 3 commits into from
Apr 23, 2024

Conversation

phillipleblanc
Copy link
Contributor

@phillipleblanc phillipleblanc commented Apr 23, 2024

Which issue does this PR close?

Closes #10151

Rationale for this change

What changes are included in this PR?

Updates .asf.yaml to point to the new top-level website, and adds the required links to the ASF as required by https://www.apache.org/foundation/marks/pmcs#navigation

I mirrored what https://arrow.apache.org does and grouped these links into an ASF Links section

According to https://github.com/apache/infrastructure-asfyaml/blob/main/README.md#publish - removing the subdir config in publish will do what we want.

Are these changes tested?

Here is a screenshot of what it looks like locally:
Screenshot 2024-04-23 at 11 40 35 AM

Are there any user-facing changes?

N/A

@github-actions github-actions bot added documentation Improvements or additions to documentation development-process Related to development process of DataFusion labels Apr 23, 2024
Copy link
Member

@andygrove andygrove 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 @phillipleblanc. I think it would be good to wait for @alamb to also review before merging.

@phillipleblanc
Copy link
Contributor Author

LGTM. Thanks @phillipleblanc. I think it would be good to wait for @alamb to also review before merging.

Yeah - there are some links to arrow.apache.org/datafusion still leftover in the repo as well - but I also think we should wait on those changes until we confirm this actually publishes to the right place.

Also I wasn't able to figure out how to add the redirect from arrow.apache.org/datafusion to datafusion.apache.org. @alamb did you have an idea on how to do that?

@@ -27,7 +27,7 @@ notifications:
jira_options: link label worklog
github:
description: "Apache DataFusion SQL Query Engine"
homepage: https://arrow.apache.org/datafusion
homepage: https://datafusion.apache.org/
Copy link
Member

@viirya viirya Apr 23, 2024

Choose a reason for hiding this comment

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

It should be https://datafusion.apache.org/datafusion/?

Copy link
Member

Choose a reason for hiding this comment

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

https://datafusion.apache.org/ will give you:

Screenshot 2024-04-22 at 8 19 35 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

After this change it should start publishing to https://datafusion.apache.org without needing the subdirectory 🤞

@alamb
Copy link
Contributor

alamb commented Apr 23, 2024

Also I wasn't able to figure out how to add the redirect from arrow.apache.org/datafusion to datafusion.apache.org. @alamb did you have an idea on how to do that?

The only thing I could think of is creating explicit redirect pages for each .html page in https://github.com/apache/arrow-site

I agree having redirects will be important (and I m am not sure what will be on https://arrow.apache.org/datafusion/ afterwards).

Thus what I think we should do is to merge this PR, see its effects and I'll file a follow on ticket for the next tasks

@alamb
Copy link
Contributor

alamb commented Apr 23, 2024

Thank you for your work / help and reviews @phillipleblanc

@alamb alamb merged commit da82cec into apache:main Apr 23, 2024
24 checks passed
@alamb
Copy link
Contributor

alamb commented Apr 23, 2024

Filed #10194 to track redirects

@alamb
Copy link
Contributor

alamb commented Apr 23, 2024

It appears to have worked!

https://datafusion.apache.org/ now shows:

Screenshot 2024-04-23 at 6 43 58 AM

@alamb
Copy link
Contributor

alamb commented Apr 23, 2024

It appears that https://arrow.apache.org/datafusion/ has an older snapshot of the site (as in it was not updated as well):

Screenshot 2024-04-23 at 6 45 03 AM

@alamb
Copy link
Contributor

alamb commented Apr 23, 2024

I think I have figured out the redirects -- see apache/arrow-site#502

ccciudatu pushed a commit to hstack/arrow-datafusion that referenced this pull request Apr 26, 2024
* Update .asf.yaml to publish to root

* Update website to have top-level ASF links
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 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create Project Website (datafusion.apache.org)
4 participants