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] fix broken SynapseML link #4712

Merged
merged 3 commits into from
Oct 27, 2021
Merged

[docs] fix broken SynapseML link #4712

merged 3 commits into from
Oct 27, 2021

Conversation

jameslamb
Copy link
Collaborator

SynapseML (formerly MMLSpark) maintainers recently did another docs re-organization (microsoft/SynapseML#1221), and as a result a link in LightGBM's documentation is currently broken.

From the most recent check-links job.

URL https://github.com/microsoft/SynapseML/blob/master/docs/lightgbm.md' Name the SynapseML documentation'
Parent URL file:///home/runner/work/LightGBM/LightGBM/docs/_build/html/Parallel-Learning-Guide.html, line 180, col 167
Real URL https://github.com/microsoft/SynapseML/blob/master/docs/lightgbm.md
Check time 1.243 seconds
Result Error: 404 Not Found

reference: https://github.com/microsoft/LightGBM/runs/3987915929?check_suite_focus=true

This has happened several times over the last year:

To fix the broken link and avoid disruptions from future re-organizations in SynapseML, this PR proposes replacing the LightGBM-specific link that is now broken to just link to the root of the SynapseML repo instead.

cc @imatiach-msft

@jameslamb jameslamb added the doc label Oct 24, 2021
@jameslamb jameslamb requested a review from StrikerRUS October 24, 2021 20:37
@imatiach-msft
Copy link
Contributor

@jameslamb sounds good to me, sorry about breaking you so often! Also FYI @serena-ruan

@jameslamb
Copy link
Collaborator Author

sorry about breaking you so often

no problem, just wanted you to be aware!

@StrikerRUS
Copy link
Collaborator

@jameslamb Maybe we can just remove ... and the SynapseML documentation ... part from the original sentence because this new very general link to the SynapseML repo's root doesn't look very useful for readers?

@jameslamb
Copy link
Collaborator Author

Maybe we can just remove ... and the SynapseML documentation ... part from the original sentence

Yeah I agree! Good point. I just pushed a commit removing that.

Copy link
Collaborator

@StrikerRUS StrikerRUS left a comment

Choose a reason for hiding this comment

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

Thanks!

@StrikerRUS StrikerRUS merged commit 585b86a into master Oct 27, 2021
@StrikerRUS StrikerRUS deleted the docs/synapse branch October 27, 2021 22:40
@StrikerRUS StrikerRUS mentioned this pull request Oct 27, 2021
18 tasks
@StrikerRUS StrikerRUS mentioned this pull request Jan 6, 2022
13 tasks
@jameslamb jameslamb mentioned this pull request Oct 7, 2022
40 tasks
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants