Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This branch/PR is based off of the docs updates at #380.
The linked updates to documentation mean that the tool can start to promote better self-serve resolution to compliance problems. As a first step, status failures should be linking to the help documents in order to help new users diagnose and hopefully fix any encountered errors.
I originally tried to keep the changes small, since the only product focused change here is to print a message like "see the docs" when the status command found errors. That became difficult and I found myself having to build workarounds because the existing way that reporters and commands interacted involved lots of block yielding and was generally more complex than it needed to be. I decided to rewrite the reporter system to make things simpler, which made adding this new functionality much easier as well.
The reporter and command changes largely amount to two things
begin
andend
hooks for each ofcommand
,application
,source
anddependency
as needed to output information. It's now simpler to write command methods because there is less use of yielded blocks to add or override functionality