dotnet / docs-tools

This repo contains GitHub Actions and other tools that are designed to be invoked on DocFx repositories.
Creative Commons Attribution 4.0 International
17 stars 28 forks source link

[CleanRepo]: Images for image hyperlinks flagged as orphans #396

Open wadepickett opened 2 months ago

wadepickett commented 2 months ago

Clean Repo seems to be flagging images incorrectly as orphaned for image hyperlinks. The image used to display for the image hyperlink is fine but in the case of an image hyperlink, the resulting image the hyperlink retrieves on a click is determined to be orphaned in the report.

Severity: In the old aspnetdocs repo we had over 3000 image hyperlinks which Clean Repo flagged incorrectly as orphaned. However, I don't think image hyperlinks are used as much like this in other repos,

It used to be years ago, that two images were provided for screenshot image hyperlinks for our docs. One larger and one smaller and the smaller one was used as the link itself. Clicking on the screenshot or whatever the image was of, resulted in a larger version of the image being retrieved and displayed.

Recreating the issue:

Results: The list of images returned as orphaned will include the image from the image link used for the full image that is returned when the link is clicked.

Example: In a link like the following, external-authentication-services/_static/image25.png would be determined incorrectly to be orphaned: [![Image displaying default Facebook home page](external-authentication-services/_static/image26.png "Click to Expand the Image")](external-authentication-services/_static/image25.png)

This example image link can be found in this .md article example [here].https://raw.githubusercontent.com/dotnet/AspNetDocs/main/aspnet/web-api/overview/security/external-authentication-services.md)

It does not matter if tooltip text exists in the hyperlink or not. Same incorrect results.

Some helpful regex that could be used to find these cases: In case you were interested here is regex I used to find examples of image hyperlinks with or without tooltip text in them:

Find image hyperlinks with tooltip text not in them: \[!\[.*?\]\(.*?\)\]\(.*?\)

Find image hyperlinks with tooltip text in them: \[!\[.*?".*?"\)\]\(.*?\)

wadepickett commented 2 months ago

@gewarren FYI