Include Commit Prefix of CFN UserGuide in Latest Documentation Lookup Errors

[ScriptAutomate]

Problem

At times, the LIVE documentation of the AWS CFN User Guide may have working documentation links, and at other times the same links may be broken.

This has become weirdly apparent in the latest auto-generated PRs in this repository. These issues do look unrelated to the GitHub source repository of the guide and seem more related to inconsistency in the LIVE version of the User Guide (which may be reverting changes at times).

Including the latest GitHub source repo Commit prefix and link, along with a datetime stamp, in aws-cfn-resource-specs/documentation-lookup-errors.json could potentially be helpful in finding out why these inconsistencies happen in the future.

Examples of Problem

• In bb0e93b, we see many links were no longer broken in the LIVE CFN User Guide. This is with zero change in the v8.0.0 CFN resource specs.
• In 23d922d, one day later with the same v8.0.0 resource spec Documentation links, we see many of the links reintroduced as broken.

In both cases, it does not look like the documentation links referenced have ever been committed to the master branch of the public GitHub repo, as they present under both MissingFromAWSGitHubSourceRepo and BrokenDocLinks in 23d922d:documentation-lookup-errors.json

NOTE: In the above examples, this is purely outside of public control due to a disconnect between what AWS has as published/LIVE documentation, and the GitHub Source. The best this project can do is provide the most amount of public information (latest cfn spec version, latest cfn user guide commit ID in GitHub source, and a datetime stamp of attempted doc lookup on published/LIVE user guide documentation).

What Does This Mean?

It could mean either:

• There may be PRs being done against the LIVE CFN User Guide source documentation (internal AWS code repo, not accessible to public) that are reintroducing issues at times due to overlooked merge conflicts, resulting in some form of regression
• Or it may also be that the documentation isn't yet ready for public consumption, even though the resources are present in at least one regional cfn spec file; the documentation may have been published, and then retracted, due to some kind of documentation content errors that AWS chose to pull down
• Some other unintentional errors

All that I can tell is that yesterday the documentation was appearing in the published user guide, no longer is today, and has yet to appear in the GitHub source. It is weird behavior. Introducing some additional values to the documentation-lookup-errors.json file could be helpful in the future and if reaching out to project maintainers or support.

Ultimately, this could either be a small problem (only related to something going on with the latest and greatest content being introduced into CFN and the cfn spec files), or it could be a symptom of why certain documentation has either never existed or potentially had existed but no longer does. Issues like that can be seen with non-existent documentation for certain opsworks and codepipeline property types listed in documentation-broken-links-detailed.json since v5.3.0 and as mentioned in Issue #428 of the aws cfn user guide github repo.

[ScriptAutomate]

Closing this issue, as other aspects of this repo are providing quite a bit of automated auditing as it is, which should suffice.