docs: Add ASF attribution #186
Conversation
simicd
force-pushed
the
docs/add-asf-attribution
branch
2 times, most recently
from
71bfb99
to
8ee0555
Compare
simicd
force-pushed
the
docs/add-asf-attribution
branch
from
8ee0555
to
f001bb1
Compare
doc/source/conf.py
Outdated
| project = 'Apache Arrow Flight SQL Adapter for PostgreSQL' | ||
| copyright = f'2019-{datetime.now().year}, Apache Software Foundation' | ||
| trademark = [ | ||
| "Apache Arrow Flight, Arrow Flight, Apache, the Apache feather logo, and the Apache Arrow project logo", |
There was a problem hiding this comment.
Should we add some words for "Flight SQL" here too?
Hmm, ADBC doesn't mention Flight nor Flight SQL: apache/arrow-adbc#1423
There was a problem hiding this comment.
Yes sounds good, added a proposal by explicitly mentioning Arrow Flight SQL
doc/source/conf.py
Outdated
| trademark = [ | ||
| "Apache Arrow Flight, Arrow Flight, Apache, the Apache feather logo, and the Apache Arrow project logo", | ||
| "are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries." | ||
| ] |
There was a problem hiding this comment.
Can we use copyright instead of introducing trademark like apache/arrow#39505 ? I think that using copyright is simpler.
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
doc/source/conf.py
Outdated
| copyright = f'2022-{datetime.now().year}, Apache Software Foundation' | ||
| trademark = [ | ||
| "Apache Arrow Flight, Arrow Flight, Arrow Flight SQL, Apache, the Apache feather logo, and the Apache Arrow project logo", | ||
| "are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries." | ||
| ] |
There was a problem hiding this comment.
Can we use
copyrightinstead of introducingtrademarklike apache/arrow#39505 ? I think that usingcopyrightis simpler.
That would be elegant, I tried the following but for some reason it doesn't split the iterable into multiple lines and the Sphinx version looks squeezed (even though the docs state from Sphinx v7.1 onwards it should work):
| copyright = f'2022-{datetime.now().year}, Apache Software Foundation' | |
| trademark = [ | |
| "Apache Arrow Flight, Arrow Flight, Arrow Flight SQL, Apache, the Apache feather logo, and the Apache Arrow project logo", | |
| "are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries." | |
| ] | |
| copyright = (f'2022-{datetime.now().year}, Apache Software Foundation\n', | |
| "Apache Arrow Flight, Arrow Flight, Arrow Flight SQL, Apache, the Apache feather logo, and the Apache Arrow project logo", | |
| "are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries." | |
| ) | |
| trademark = [] |
There was a problem hiding this comment.
Hmm. OK. Let's use one string for copyright like apache/arrow#39505 :
copyright = (
f'2022-{datetime.now().year}, Apache Software Foundation. '
"Apache Arrow Flight, Arrow Flight, Arrow Flight SQL, Apache, the Apache feather logo, "
"and the Apache Arrow project logo are either registered trademarks or trademarks of "
"The Apache Software Foundation in the United States and other countries."
)
|
Thanks a lot for the thorough review @kou, very helpful! I accepted all changes, there are two comments left above |
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
doc/source/conf.py
Outdated
| copyright = f'2022-{datetime.now().year}, Apache Software Foundation' | ||
| trademark = [ | ||
| "Apache Arrow Flight, Arrow Flight, Arrow Flight SQL, Apache, the Apache feather logo, and the Apache Arrow project logo", | ||
| "are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries." | ||
| ] |
There was a problem hiding this comment.
Hmm. OK. Let's use one string for copyright like apache/arrow#39505 :
copyright = (
f'2022-{datetime.now().year}, Apache Software Foundation. '
"Apache Arrow Flight, Arrow Flight, Arrow Flight SQL, Apache, the Apache feather logo, "
"and the Apache Arrow project logo are either registered trademarks or trademarks of "
"The Apache Software Foundation in the United States and other countries."
)
Which issue does this PR close?
Closes #185
Rationale for this change
Aligning Apache Software Foundation attribution across projects
What changes are included in this PR?
arrow-ballistaorarrow-datafusionrepoAre there any user-facing changes?
Updated footer on documentation website
Previously
Newly
