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

Restructure folders and attachments to check for orphaned resources #77

Open
bparks13 opened this issue Sep 27, 2024 · 1 comment
Open
Assignees
Milestone

Comments

@bparks13
Copy link
Member

DocLinkChecker has a feature that allows it to check if any resources are orphaned (i.e., not used in the docs). However, it does not currently work due to our folder hierarchy / naming convention. To rectify this, we can move all images to an '.attachments' folder (this is the recommended hierarchy for docs management by Docfx and DocLinkChecker). Then, we can add '.attachments' to the ResourceFolderNames argument of the DocLinkChecker.config file.

There are some additional steps that might be necessary, such as moving the *-operator.svg files into a specific subfolder that is not checked at this time. The reason being that DocLinkChecker operates on the raw *.md files, and does not check the HTML files, but the operator SVG images are only placed into the HTML pages after running through the templating process.

While doing this, it would make sense to organize the images into specific subfolders to make it easier to browse and find specific images.

@bparks13 bparks13 self-assigned this Sep 27, 2024
@jonnew jonnew modified the milestones: Infrastructure, Nitpicks Oct 15, 2024
@jonnew
Copy link
Member

jonnew commented Oct 15, 2024

I don't think this is a huge deal. Also, I'm know, esp in docs repos, to place content in there that might be useful in future. So, lets put it in the wishlist for now.

@jonnew jonnew modified the milestones: Nitpicks, Wishlist Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants