Document known errors and warnings raised by automated tools

kellylee-gds commented 5 years ago

What

Next steps following #1280 and following conversation in https://github.com/alphagov/govuk-frontend/pull/1616#pullrequestreview-304527113 where we decided that we're going to link to a list of Github issues for the errors/warnings.

We should document each error message in a Github issue. @m-green will help us work out the best issue template for doing this.

Why

To help our users understand why these errors/warnings may be raised by automated tools and reassure them no action is required on their behalf.

Who needs to know about this

Developers, Amy, Mark

Done when

[x] Decision has been made on each error/warning as to where documentation will live
[x] Identify whether there are cases where users may need to take action
[ ] We've decided on the Github issue template for such errors/warnings
[ ] Create individual Github issue for each error/warning

m-green commented 5 years ago

It's likely this will be a section in the documentation that we're writing for https://github.com/alphagov/govuk-design-system/issues/1060, rather than separate docs.

hannalaakso commented 4 years ago

I wonder if there's any scope for picking this up soon. The interim table that documents the warnings and which we frequently point users to is hard to use as you have to scroll horizontally to view it, and it might not even be obvious that there's more content to see on horizontal scroll.

querkmachine commented 5 months ago

We now maintain a board of known errors reported by automated testing tools: https://github.com/orgs/alphagov/projects/37

I'm going to close this as completed. Feel free to reopen if you think that's in error.

alphagov / govuk-frontend