Skip to content

[DOCS] Automatically audit and flag broken URLs in codebase/docs #60720

@ScriptAutomate

Description

@ScriptAutomate

Description

Automatically audit and flag broken URLs in codebase/docs

Suggested Fix

Use GitHub Actions to verify that links across the codebase/docs are not broken.

Using Sphinx's built-in linkcheck doesn't include validating links across the rest of the project, such as within any *.md files, or configuration files.

Type of documentation

  • Salt documentation
  • Salt modules

Metadata

Metadata

Assignees

No one assigned

    Labels

    broken linksFor broken documentation linksdocumentationRelates to Salt documentationseverity-medium3rd level, incorrect or bad functionality, confusing and lacks a work aroundtime-estimate-sprint

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions