Skip to content

Enable HTMLProofer Images check and remove orphaned openvox images #317

@miharp

Description

@miharp

Background

Raised by @binford2k: most images in docs/_openvox_8x/images are no longer relevant and should be removed. While checking, we found the link checker does not validate images.

Our rake test:links runs HTMLProofer scoped to checks: ['Links'] (Rakefile), so only <a href> links are validated. HTMLProofer's default checks is ['Links', 'Images', 'Scripts'], and the Images check validates that internal image references aren't broken — we've opted out of it, so a broken <img> (e.g. after deleting an image that's still referenced) won't fail CI.

Proposed work

1. Enable the Images check

Add 'Images' to the checks: array in the test:links task (Rakefile). Existing config already mitigates the noisy parts:

  • disable_external: true → external images aren't fetched
  • ignore_empty_alt: true → empty alt="" won't fail

Heads-up: turning this on may surface pre-existing broken image references across all collections (not just openvox), so a first pass to fix/audit those is likely needed before it can go green in CI.

2. Remove orphaned openvox images

12 of the 33 files in docs/_openvox_8x/images have zero references anywhere in the docs and can be deleted immediately:

environment_directories.svg
forge_add_module.png
forge_add_release.png
forge_register.png
forge_upload.png
os-x-signature-gui-1.png
os-x-signature-gui-2.png
puppet agent downloads.png
windows_invalid_signature.png
windows_package_signatures.png
wizard_server.png
yourmodules.png

The other 21 are still referenced by pages (Forge-upload walkthrough, module-deletion flow, Windows signature screenshots, etc.). Trimming those further means removing/updating the referencing pages too — and with the Images check enabled, CI would then catch any image refs left dangling.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions