You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "itholic (via GitHub)" <gi...@apache.org> on 2023/11/27 02:46:05 UTC
[PR] [SPARK-46111][DOCS][PYTHON] Add copyright to the PySpark official documentation. [spark]
itholic opened a new pull request, #44026:
URL: https://github.com/apache/spark/pull/44026
### What changes were proposed in this pull request?
This PR proposes to add the Apache Spark Foundation copyright notice to the bottom of the PySpark official documentation.
### Why are the changes needed?
The addition of the copyright notice is necessary to ensure compliance with the Apache Software Foundation's requirements for project documentation.
### Does this PR introduce _any_ user-facing change?
No API changes, but users will now see the Apache Spark Foundation copyright notice at the bottom of each page of the PySpark documentation as below:
<img width="782" alt="Screenshot 2023-11-27 at 11 35 46 AM" src="https://github.com/apache/spark/assets/44108233/c22ad99e-8f7a-4364-91a6-8862aea9f3e7">
### How was this patch tested?
Manually build the docs and confirm.
### Was this patch authored or co-authored using generative AI tooling?
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46111][DOCS][PYTHON] Add copyright to the PySpark official documentation. [spark]
Posted by "itholic (via GitHub)" <gi...@apache.org>.
itholic commented on code in PR #44026:
URL: https://github.com/apache/spark/pull/44026#discussion_r1405579338
##########
python/docs/source/_templates/spark_footer.html:
##########
@@ -0,0 +1,3 @@
+<p class="copyright">
+ {{copyright}} The Apache Software Foundation, Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
Review Comment:
FYI: I follow this copyright format from [Apache Spark official web page](https://spark.apache.org/).
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46111][DOCS][PYTHON] Add copyright to the PySpark official documentation. [spark]
Posted by "srowen (via GitHub)" <gi...@apache.org>.
srowen commented on code in PR #44026:
URL: https://github.com/apache/spark/pull/44026#discussion_r1405583515
##########
python/docs/source/conf.py:
##########
@@ -124,7 +125,8 @@
# General information about the project.
project = 'PySpark'
-copyright = ''
+# We have our custom "spark_footer.html" template, using copyright for the current year.
+copyright = f"Copyright @ {datetime.now().year}"
Review Comment:
I don't even think year is needed but it's fine and a nice touch
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46111][DOCS][PYTHON] Add copyright to the PySpark official documentation. [spark]
Posted by "itholic (via GitHub)" <gi...@apache.org>.
itholic commented on code in PR #44026:
URL: https://github.com/apache/spark/pull/44026#discussion_r1405586947
##########
python/docs/source/conf.py:
##########
@@ -124,7 +125,8 @@
# General information about the project.
project = 'PySpark'
-copyright = ''
+# We have our custom "spark_footer.html" template, using copyright for the current year.
+copyright = f"Copyright @ {datetime.now().year}"
Review Comment:
I refer to Pandas docs but we can remove the year if we want:
<img width="485" alt="Screenshot 2023-11-27 at 12 40 57 PM" src="https://github.com/apache/spark/assets/44108233/438e05d8-95cf-4e49-b253-a2e6fbd027ac">
Can we just remove the year?
##########
python/docs/source/conf.py:
##########
@@ -124,7 +125,8 @@
# General information about the project.
project = 'PySpark'
-copyright = ''
+# We have our custom "spark_footer.html" template, using copyright for the current year.
+copyright = f"Copyright @ {datetime.now().year}"
Review Comment:
I refer to Pandas docs but we can remove the year if we want
<img width="485" alt="Screenshot 2023-11-27 at 12 40 57 PM" src="https://github.com/apache/spark/assets/44108233/438e05d8-95cf-4e49-b253-a2e6fbd027ac">
Can we just remove the year?
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46111][DOCS][PYTHON] Add copyright to the PySpark official documentation. [spark]
Posted by "srowen (via GitHub)" <gi...@apache.org>.
srowen commented on code in PR #44026:
URL: https://github.com/apache/spark/pull/44026#discussion_r1405611472
##########
python/docs/source/conf.py:
##########
@@ -124,7 +125,8 @@
# General information about the project.
project = 'PySpark'
-copyright = ''
+# We have our custom "spark_footer.html" template, using copyright for the current year.
+copyright = f"Copyright @ {datetime.now().year}"
Review Comment:
Id leave it, it's fine
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46111][DOCS][PYTHON] Add copyright to the PySpark official documentation. [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #44026:
URL: https://github.com/apache/spark/pull/44026#issuecomment-1827072792
cc @srowen FYI
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46111][DOCS][PYTHON] Add copyright to the PySpark official documentation. [spark]
Posted by "itholic (via GitHub)" <gi...@apache.org>.
itholic commented on code in PR #44026:
URL: https://github.com/apache/spark/pull/44026#discussion_r1405621098
##########
python/docs/source/conf.py:
##########
@@ -124,7 +125,8 @@
# General information about the project.
project = 'PySpark'
-copyright = ''
+# We have our custom "spark_footer.html" template, using copyright for the current year.
+copyright = f"Copyright @ {datetime.now().year}"
Review Comment:
Got it. Thanks for the review!
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46111][DOCS][PYTHON] Add copyright to the PySpark official documentation. [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #44026: [SPARK-46111][DOCS][PYTHON] Add copyright to the PySpark official documentation.
URL: https://github.com/apache/spark/pull/44026
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46111][DOCS][PYTHON] Add copyright to the PySpark official documentation. [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #44026:
URL: https://github.com/apache/spark/pull/44026#issuecomment-1828923539
Merged to master.
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org