Copy tech alerts over to relevant product pages so they can be found

[CEKrause]

There are quite a few tech alerts that contain very pertinent information about product bugs and quality information that unless you know it exists in the tech register, is easy to miss.

I have copied the relevant information across into the "Quality" tabs of the relevant products so that all the information about a product is together in the product pages.

[github-actions]

Preview is ready!

View the preview:

🌐 PR Preview 376

You can also view the deploy log or read the documentation.

[benji-glitsos-ga]

I really like this so far. I'll just ask some questions to see how your design will handle these cases:

• If there is a product release tech alert about the product, we will paste it into the History tab?
• If there is an alert about the product, we will paste it into the Quality tab?
• Will the 'Known issues' heading encapsulate everything we may want to put in this section in the future, or should be broaden it to something like 'Issues and alerts'?

Also, Im not sure if this heading should be 'Known issues': https://pr-376-preview.khpreview.dea.ga.gov.au/data/product/dea-hotspots/?tab=quality#dea-hotspots-tech-alerts

[CEKrause]

@benji-glitsos-ga

I really like this so far. I'll just ask some questions to see how your design will handle these cases:

• If there is a product release tech alert about the product, we will paste it into the History tab?

I did some quick checks while I was preparing this PR. It seems that where there was actual useful information (as opposed to just a note that a new version was available), the information was already in the History tab. I don't think we need to post the Tech Alert in its entirety into the History tab, but we do need to make sure that any actual useful information about changes are included in the product history tab. As of this PR, anything in the Tech Alerts has been cross checked.

• If there is an alert about the product, we will paste it into the Quality tab?

Temp downtimes, no, but anything long lasting that could affect quality, yes. Again, this PR has moved anything important across.

• Will the 'Known issues' heading encapsulate everything we may want to put in this section in the future, or should be broaden it to something like 'Issues and alerts'?

I wasn't really sure what the heading should be. I just used "Known Issues" because it seemed relevant for the content, but I am very happy to take suggestions.

Also, Im not sure if this heading should be 'Known issues': https://pr-376-preview.khpreview.dea.ga.gov.au/data/product/dea-hotspots/?tab=quality#dea-hotspots-tech-alerts

[benji-glitsos-ga]

Thanks for answering those questions. That all seems good.

I thought about the 'Known issues' heading and my best suggestion is:

Issues and resolutions

This is because the list may contain some issues that have been resolved (and they should be marked as resolved, as in the Tech Alerts)

[CEKrause]

Thanks for answering those questions. That all seems good.

I thought about the 'Known issues' heading and my best suggestion is:

Issues and resolutions

This is because the list may contain some issues that have been resolved (and they should be marked as resolved, as in the Tech Alerts)

Though some of them won't have been resolved.

Maybe "Known issues are resolutions" to capture both?

[benji-glitsos-ga]

We can do that. Now I'm just nitpicking - I feel that 'Known' isn't needed, since all issues are known issues. And it can be more 'skimmable' to the reader if the heading starts with the word 'Issue'.

[robbibt]

I really love this! A "Known issues" register is something we've been needing for a long time - this will be really, really useful for our products (I know @simonaoliver has raised this before too).

Some stray thoughts:

• Is this actually the right place for "resolved" issues? If I was a user browsing the "Quality" tab, I'm not sure I'd be that interested in fixed problems, because they wouldn't affect my work - I'd be more concerned with active known issues that currently affect the data. I'd be tempted to restrict these to ongoing issues that are still active (unless the resolution of an issue affects how users need to analyse/use the data)
• I think we need to make sure this is generic and not tied specifically to issues with a corresponding "Tech alerts" post - e.g. DEA Intertidal has a bunch of known data issues, but they are inherent issues with the data that were present since publication. It would be great to document these under this same "Known issues" heading for consistency.
• As the list of issues grows, I can see them adding a fair bit of clutter to the "Quality" tab. Not a bad thing, but can we wrap them up in collapsable headings that a user could click on for more info? e.g.:

I kind of like "Known issues" for its simplicity - it's commonly used in these kinds of data repos and shows we are aware of these problems but haven't necessarily fixed them yet. But "Known issues and alerts" could work too.

[CEKrause]

My thought behind including key resolved issues is that some users may have downloaded or created products from older versions of the data where the resolved issues are still relevant. I dont think any of the outages are useful, but quality issues that have been resolved could be very relevant?

[robbibt]

Yep, fair enough! I guess we can just clearly label them as resolved, and perhaps move them to the bottom of the list of issues so they are a bit less prominent

[benji-glitsos-ga]

Hi Robbi and Claire - I think those are good ideas.

• Title can be "Known issues"
• If an issue is resolved, we can append "Resolved: " to the title of the issue.
• The idea to use dropdowns is good, but I'm aware that it will add extra manual work for contributors. Versus if we don't use dropdowns, we can just copy-paste as-is from the tech alerts.

[CEKrause]

The syntax for the drop downs is really easy, so you and I can manage that, Benji? Maybe we can collapse the resolved ones, and keep the open ones as plain text?

[benji-glitsos-ga]

It's fairly easy - I was mainly thinking of the other stakeholders who would be encouraged to keep this up to date going forward. If we make it as easy for them as possible, they are more likely to edit it as opposed to neglecting it.

[robbibt]

As a stakeholder, as long as there's a nice template/working example present in the repo, I think we'll be able to work it out. 🙂 Maybe we can test it out and see what it would look like? If it doesn't seem worth the effort we can reconsider... I can just see certain listings (e.g. ARD) accumulating a rapidly growing collection of known issues as time goes on, and it'd be good keep things neat and tidy.

[CEKrause]

OK. So to summarise to make sure I understand the consensus:

• "Known Issues" for the heading
• We will put the closed issues in drop downs and write "Resolved" in the heading, so that all the info is together for stakeholders.

I'll go in and amend this PR with these changes so we can see how it'll look.

[CEKrause]

I think that looks pretty good now? Thoughts?

[benji-glitsos-ga]

We will need to add this Tech Alert to the relevant product pages once the PR has been merged: #384