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

docs: Add ASF attribution #580

Merged
merged 4 commits into from
Feb 11, 2024
Merged

Conversation

simicd
Copy link
Contributor

@simicd simicd commented Feb 7, 2024

Which issue does this PR close?

Closes #553

Rationale for this change

Aligning Apache Software Foundation attribution across projects

What changes are included in this PR?

  • Add ASF footer
  • Update docs requirements.txt (align with arrow-datafusion)
  • Fix issues preventing docs compilation
  • Update docs README, adding more precise instructions on how to run sphinx build

Are there any user-facing changes?

Updated footer on documentation website

image

@simicd simicd changed the title docs:: Add ASF attribution docs: Add ASF attribution Feb 8, 2024
@simicd simicd force-pushed the docs/asf-attribution branch 2 times, most recently from 3ddcf2f to 696fe2c Compare February 8, 2024 23:33
@andygrove
Copy link
Member

Thanks @simicd but could we just do the documentation changes in this PR rather than make functional changes to the code as well?

@simicd
Copy link
Contributor Author

simicd commented Feb 10, 2024

Thanks for the feedback @andygrove, sure will do that. Background: The changes were required to make it work (on Windows, not sure if Linux has those issues too):

  • Initially I couldn't pip install requirements-310.txt because Datafusion 0.35.0 seems to rely on pyarrow >= 11.0, the current requirements-310.txt still lists pyarrow 6.0
  • Once I added that one of the unit tests failed in CI
  • The sphinx command would fail because the use of pipes in Python docstrings (|n|) seems not to be allowed so I escaped it

So I thought I leave these changes in to make the builds reproducible. I will now limit the changes to docs only and raise a separate ticket & PR for the remaining issue(s).

@simicd
Copy link
Contributor Author

simicd commented Feb 10, 2024

Undid the changes that are not directly related to docs, please let me know if you have any further suggestions!

copyright = "2022, Apache Software Foundation"
author = "Arrow DataFusion Authors"
project = "Apache Arrow DataFusion"
copyright = "2019-2024, Apache Software Foundation"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should the starting year remain 2022 or be 2019?

Copy link
Member

Choose a reason for hiding this comment

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

I think 2019 is good, because that was when the project became part of Apache Arrow

@andygrove andygrove merged commit 476ca22 into apache:main Feb 11, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use correct attribution in footer of documentation pages
2 participants