Automate Hyperlink Checking

[ohsh6o]

Action Item

This is a ...

• enhancement - Something could be better.

This relates to ...

• the Guide to OSCAL-based FedRAMP Content (PDF)
• the Guide to OSCAL-based FedRAMP System Security Plans (SSP) (PDF)
• the Guide to OSCAL-based FedRAMP Security Assessment Plans (SAP) (PDF)
• the Guide to OSCAL-based FedRAMP Security Assessment Reports (SAR) (PDF)
• the Guide to OSCAL-based FedRAMP Plan of Action and Milestones (POA&M) (PDF)
• the FedRAMP SSP OSCAL Template (JSON or XML Format)
• the FedRAMP SAP OSCAL Template (JSON or XML Format)
• the FedRAMP SAR OSCAL Template (JSON or XML Format)
• the FedRAMP POA&M OSCAL Template (JSON or XML Format)

Describe the problem or enhancement

Our current documentation, and a significant subset of example resources, repeatedly hyperlink to external assets, from NIST OSCAL documents. Checking these can be exhaustive and error-prone via manual review of the documents, baselines, and templates. Automated checks can help flag and programmatically replace as many links as possible.

Goals:

Documentation references are important, and keeping them close as possible and relevant to block of text or code without using references and citations that distance them from that material, would be ideal.

Dependencies:

None

Acceptance Criteria

• All FedRAMP Documents Related to OSCAL Adoption affected by the changes in this issue have been updated.
• A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.

[ohsh6o]

Will need to evaluate this further with metachris/pdfx#47 or an alternative issue.

[volpet2014]

@Rene2mt - do we actually check all links before release Guides updates for OSCAL?

[aj-stein-gsa]

This issue still seems valid, especially now with the introduction of the help-url prop in constraint files and such. I will leave this golden oldie as-is and move to Ready as it is something we should tackle in the near to medium-term future.