-
Notifications
You must be signed in to change notification settings - Fork 29k
[SPARK-30731] Update deprecated Mkdocs option #27626
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
Conversation
|
Test build #118651 has finished for PR 27626 at commit
|
Split from #27534. ### What changes were proposed in this pull request? This PR updates a deprecated Mkdocs option to use the new name. ### Why are the changes needed? This change will prevent the docs from failing to build when we update to a version of Mkdocs that no longer supports the deprecated option. ### Does this PR introduce any user-facing change? No. ### How was this patch tested? I built the docs locally and reviewed them in my browser. Closes #27626 from nchammas/SPARK-30731-mkdocs-dep-opt. Authored-by: Nicholas Chammas <[email protected]> Signed-off-by: HyukjinKwon <[email protected]> (cherry picked from commit 2ab8d67) Signed-off-by: HyukjinKwon <[email protected]>
HyukjinKwon
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
Thanks, merged to master, branch-3.0 and branch-2.4. |
Split from #27534. ### What changes were proposed in this pull request? This PR updates a deprecated Mkdocs option to use the new name. ### Why are the changes needed? This change will prevent the docs from failing to build when we update to a version of Mkdocs that no longer supports the deprecated option. ### Does this PR introduce any user-facing change? No. ### How was this patch tested? I built the docs locally and reviewed them in my browser. Closes #27626 from nchammas/SPARK-30731-mkdocs-dep-opt. Authored-by: Nicholas Chammas <[email protected]> Signed-off-by: HyukjinKwon <[email protected]> (cherry picked from commit 2ab8d67) Signed-off-by: HyukjinKwon <[email protected]>
|
@nchammas . You should use a new JIRA ID because the scope is completely different. This patch lands |
|
This PR was split from #27534, and the referenced JIRA covers removing deprecated options related to building the docs. So the scope of the JIRA is fine, IMO, and includes this PR. I'm not sure why this patch was backported to |
|
I think this is OK for a backport, as it is a potential 'fix', is quite minor, and in any event only affects doc gen. Any problem it would cause would be obvious at docs build time. |
|
Yes, @srowen . The individual PR is okay for backporting. The problem at that time was that @nchammas had three independent PRs had the same JIRA ID (SPARK-30731) while he split one PR to three PRs.
|
|
Yes, I couldn't notice this links the same JIRA. Thanks for correcting it @dongjoon-hyun |
|
Also, I tested and verified it works, with Python 2.7, in mkdocs 0.17 (2017-10-19) which is before Spark 2.3 (2018-02-28). This mkdocs dependency was added as of Spark 2.3 (SPARK-21485). If a release manager uses the same machine with the same environment used in Spark 2.3 for Spark 3.0 or 2.4 release, it will still work, unofficially though. If a release manager uses the same machine with the same environment used in Spark 2.4 for Spark 3.0 or Spark 2.4.x, it will work officially. So, I think technically there is virtually no overhead. |
Split from apache#27534. ### What changes were proposed in this pull request? This PR updates a deprecated Mkdocs option to use the new name. ### Why are the changes needed? This change will prevent the docs from failing to build when we update to a version of Mkdocs that no longer supports the deprecated option. ### Does this PR introduce any user-facing change? No. ### How was this patch tested? I built the docs locally and reviewed them in my browser. Closes apache#27626 from nchammas/SPARK-30731-mkdocs-dep-opt. Authored-by: Nicholas Chammas <[email protected]> Signed-off-by: HyukjinKwon <[email protected]>
Split from #27534.
What changes were proposed in this pull request?
This PR updates a deprecated Mkdocs option to use the new name.
Why are the changes needed?
This change will prevent the docs from failing to build when we update to a version of Mkdocs that no longer supports the deprecated option.
Does this PR introduce any user-facing change?
No.
How was this patch tested?
I built the docs locally and reviewed them in my browser.