cwa-website icon indicating copy to clipboard operation
cwa-website copied to clipboard

Which versions to describe in FAQs?

Open MikeMcC399 opened this issue 3 years ago • 2 comments

This is a follow-on to the stale issue https://github.com/corona-warn-app/cwa-website/issues/971 "FAQ - Remove outdated information from FAQ and review existing entries 🔧" where the question was raised about which versions of CWA are supported and which need to be described in the current FAQs.

The FAQ descriptions have in some cases become quite complicated and difficult to read if they need to cover all past versions where many incremental changes have taken place over time.

Perhaps there could be a decision to restrict the number of previous versions covered by the FAQs e.g. only the latest version and the previous version?

This may also affect the screenshot versions shown.

There has already been one forced update (see https://github.com/corona-warn-app/cwa-app-android/issues/4270). All Android users of 2.11 were forced to update to 2.12. According to https://github.com/corona-warn-app/cwa-app-android/issues/4263#issuecomment-956033746 forced updates is an on-going topic.

If there is a general forced update in the future which sets a de facto minimum version in use for Android and iOS, then that would also be a good reason to adjust the FAQs accordingly.

Can there be a decision about which versions to continue to describe in the FAQs? The question is addressed to the Open Source Team.

MikeMcC399 avatar Nov 07 '21 10:11 MikeMcC399

@svengabr This is a topic to consider if you are in the process of reworking the FAQ design.

MikeMcC399 avatar Feb 07 '22 18:02 MikeMcC399

There has been no response to this issue in over 4 months. Please take care of it @open-source-team.

Ein-Tim avatar Apr 15 '22 15:04 Ein-Tim

CWA Android version 3.0 is being prepared as the next version for release, so I would like to raise this topic again about which versions the FAQs need to support and describe.

I would suggest deciding about an official End-of-Life (EOL) for CWA 1.x which would mean that the FAQs would no longer need to consider this version.

Some FAQs could be simplified if 1.x no longer needs to be described.

Is there any planning also for the EOL of the complete CWA app? I guess there are political, legal, contractual and epidemiological issues to consider for this aspect.

MikeMcC399 avatar Nov 14 '22 10:11 MikeMcC399

Thanks for your feedback, I will raise the topic internally in an upcoming meeting and hopefully come back with a definite answer.


EXPOSUREAPP-14338

brianebeling avatar Nov 16 '22 09:11 brianebeling

~~Considering there has been a forced update (at least on Android and that I'm aware of) it would make much sense to restrict the FAQ~~. It'd be really helpful if we could compile some examples of rough FAQ entries due to the versioning. Especially extremes would be very interesting.

That will help us identify a min version and also explain why this is a good change or why it might be necessary.

Edit: apparently the forced updated was a mistake. Thanks for the correction!

brianebeling avatar Nov 18 '22 05:11 brianebeling

@brianebeling

Which version was the update forced to?

Ein-Tim avatar Nov 18 '22 06:11 Ein-Tim

@brianebeling

I will take a look at where the FAQs could be simplified if CWA 1.x does not need to be described any more.

Unfortunately the forced update on Android 2.11 (@Ein-Tim see original post) does not help, because it was actually a mistake and the forced update was withdrawn in 2.12 and later versions, so if Android users have disabled auto-update in Google Play Store they could still be using CWA 1.15.2 (released March 24, 2021) for instance. So, it would need a management decision to announce withdrawal of support for 1.x versions. This could relieve the need to mention 1.x problems in the FAQ.

MikeMcC399 avatar Nov 18 '22 07:11 MikeMcC399

The enforced minimum app versions are currently:

Android iOS
1.0.4 1.5.3
  • I asked for clarification in https://github.com/corona-warn-app/cwa-server/issues/1962 since I expected to see CWA Android 1.5.1 as the minimum version in app_config delivered to the app.

  • If Android and iOS align on 1.5 as the minimum version, then I suggest to clean up any information in the FAQ which is only relevant for versions 1.0 to 1.4 as a first step in reducing the FAQ complexity. That would probably better be tracked in a separate issue to avoid overloading this one.

  • For the moment, wait and see!

MikeMcC399 avatar Nov 20 '22 10:11 MikeMcC399

So now we have confirmation about the minimum CWA app versions:

Android iOS
1.0.4 1.5.3

I will take a look at this and submit a separate issue.

  • see https://github.com/corona-warn-app/cwa-website/issues/3238

MikeMcC399 avatar Nov 21 '22 15:11 MikeMcC399

Hey @MikeMcC399

I got feedback from the developers regarding this issue, confirming your findings of the minimum app versions.

Generally speaking 1.X doesn't need to be described in detail, if information is missing. Barely anyone - if anyone - is using such old versions. Definitely not below 1.0.4 (android) and 1.5.3 (iOS). Going forward we'd suggest focusing on 2.X. If there is an obvious mistake with the older versions or an urgent topic we should take care of that, otherwise improving current topics and the general quality of the FAQ has precedence.

Thanks for raising the topic again, hopefully that answers your question. Let me know if you have additional questions!

brianebeling avatar Nov 24 '22 12:11 brianebeling

@brianebeling

Thank you for getting the developers' feedback. Your answer is fine.

Would you like to consider merging PR #3238? This just removes information which is no longer needed because it refers to problems which can no longer occur using the supported versions.

I think in any case that this issue can be closed since the question is answered.

MikeMcC399 avatar Nov 24 '22 14:11 MikeMcC399

Thanks again to @brianebeling! Closing this issue.

  • The issue https://github.com/corona-warn-app/cwa-website/issues/3238 is open

MikeMcC399 avatar Nov 24 '22 17:11 MikeMcC399