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.

Sign up for GitHub

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

Jump to bottom

Fixing broken links in markdown documents #2014

Merged
merged 9 commits into from
Jan 16, 2023
Merged

Fixing broken links in markdown documents #2014

merged 9 commits into from
Jan 16, 2023

Conversation

raffaeler
Copy link
Contributor

@raffaeler raffaeler commented Jan 15, 2023 •
edited by ghost
Loading

This PR replaced a broken link (missing datasheet) with:
https://www.mouser.com/datasheet/2/348/bh1750fvi-e-186247.pdf

Microsoft Reviewers: Open in CodeFlow

@ghost ghost added the area-device-bindings Device Bindings for audio, sensor, motor, and display hardware that can used with System.Device.Gpio label Jan 15, 2023
@raffaeler
Copy link
Contributor Author

This website is very slow and may cause the tests to fail.
image

Is there any way to disable the checks on certain links?

@raffaeler
Copy link
Contributor Author

azp /run

@raffaeler
Copy link
Contributor Author

@krwq I replaced several broken links with working ones
Now the tests are failing just because Hackaday.io is very slow.

Could you please take a look at the new links and verify they can be published here? I don't know if there is any "licensing" issue in linking public pdfs on external websites.

@raffaeler raffaeler changed the title Replaced broken link Fixing broken links in markdown documents Jan 15, 2023
Ellerbach
Ellerbach approved these changes Jan 16, 2023
View reviewed changes
Copy link
Member

@Ellerbach Ellerbach left a comment

Choose a reason for hiding this comment

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

Great work!

@Ellerbach
Copy link
Member

Could you please take a look at the new links and verify they can be published here? I don't know if there is any "licensing" issue in linking public pdfs on external websites.

You can link almost anything, it's to the person consuming the link to check the license associated to it. And that is the reason why, we have to have links on those datasheet as most of the time we don't really know the license associated to them. So we don't want to embed them into a repository.

@raffaeler
Copy link
Contributor Author

You can link almost anything, it's to the person consuming the link to check the license associated to it. And that is the reason why, we have to have links on those datasheet as most of the time we don't really know the license associated to them. So we don't want to embed them into a repository.

Ok, I was pretty sure but when there are "legal" issues, it is always better asking :-)

Do you think we can do anything to avoid checking the hackaday.io website? It is super-slow and currently causing the test to fail.

krwq
krwq approved these changes Jan 16, 2023
View reviewed changes
Copy link
Member

@krwq krwq left a comment

Choose a reason for hiding this comment

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

Thanks, that's a lot of them since last time we did this :)

@krwq
Copy link
Member

krwq commented Jan 16, 2023

You can update https://github.com/dotnet/iot/blob/main/.markdown-link-check.json to ignore specific website

@raffaeler
Copy link
Contributor Author

You can update https://github.com/dotnet/iot/blob/main/.markdown-link-check.json to ignore specific website

Okay, I will leave the website but remove the link.

krwq
krwq reviewed Jan 16, 2023
View reviewed changes
Documentation/README.md Outdated
@@ -134,7 +134,7 @@ This repository mainly contains two different components:

### Social

* [Hackaday.io](https://hackaday.io/)
* Hackaday.io
Copy link
Member

Choose a reason for hiding this comment

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

why not leave this as it was and just block link checker for this in the json?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am not aware of the json. That's why I was asking before.
Where is it and how does it work?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok, found.
Restored the link and added the exclusion. Let's see if this time works

@raffaeler
Copy link
Contributor Author

Looks like it worked.
I don't have merge capabilities. It's up to you now :) /cc @krwq @Ellerbach

joperezr
joperezr approved these changes Jan 16, 2023
View reviewed changes
Copy link
Member

@joperezr joperezr left a comment

Choose a reason for hiding this comment

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

This is awesome, thanks so much for taking care of this @raffaeler!

@joperezr joperezr merged commit 2de8bc9 into dotnet:main Jan 16, 2023
@raffaeler raffaeler deleted the docs_links branch January 16, 2023 19:18
@github-actions github-actions bot locked and limited conversation to collaborators Dec 8, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@krwq krwq krwq approved these changes

@Ellerbach Ellerbach Ellerbach approved these changes

@joperezr joperezr joperezr approved these changes

Assignees
No one assigned
Labels
area-device-bindings Device Bindings for audio, sensor, motor, and display hardware that can used with System.Device.Gpio
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@raffaeler @Ellerbach @krwq @joperezr