search

corona-warn-app / cwa-website

Corona-Warn-App website. The CWA development ended on May 31, 2023. You still can warn other users until April 30, 2023. More information:
https://coronawarn.app/en/faq/#ramp_down
Apache License 2.0
521 stars 224 forks source link

Remove FAQ information for versions below minimum supported #3238

Closed MikeMcC399 closed 1 year ago

MikeMcC399 commented 1 year ago

Current Implementation

The FAQs include information for all released versions.

The minimum supported versions are listed on:

https://github.com/corona-warn-app/cwa-server/blob/main/services/distribution/src/main/resources/application.yaml

    app-versions:
      latest-ios: ${IOS_LATEST_VERSION:1.5.3}
      min-ios: ${IOS_MIN_VERSION:1.5.3}
      latest-android: ${ANDROID_LATEST_VERSION:1.0.4}
      min-android: ${ANDROID_MIN_VERSION:1.0.4}
      # With ENF v2 Android apps are versioned by Version Code and not by Semantic Versioning
      min-android-version-code: ${ANDROID_MIN_VERSION_CODE:31}
      latest-android-version-code: ${ANDROID_LATEST_VERSION_CODE:31}

If a user tries to run a CWA version before the minimum version they will get a message that they need to update. They cannot access any other functionality of the app until they have updated.

Suggested Enhancement

Since it is not possible to use a CWA app which is below the minimum version, in general any information in the FAQs regarding app versions before the minimum can be removed:

Android iOS
1.0.4 1.5.3

Expected Benefits

Simplify the FAQ and reduce it to information relevant to app versions which can be used.

MikeMcC399 commented 1 year ago

There is not much which can be updated, especially because the minimum Android app version is 1.0.4.

There are two iOS troubleshooting article which could be updated because they refer to fixes which were put in place before the minimum supported version (1.5.3) was released:

https://www.coronawarn.app/en/faq/results/#migration_Apple

migration_Apple

https://www.coronawarn.app/en/faq/results/#app_does_not_open

app_does_not_open

I suggest changing the text to:

migration_Apple new app_does_not_open new

I will wait for feedback first. If the suggestion looks good then I will submit a corresponding PR to make the changes (also for the German texts).

Ein-Tim commented 1 year ago

@MikeMcC399

What about simply removing the articles & instead adding a redirect to the general troubleshooting section? I would be very in favor of doing this, as it reduces the number of articles in the FAQs.

Nevertheless, your suggestion for updating the texts also look good to me!

MikeMcC399 commented 1 year ago

@Ein-Tim

I did consider your suggestion as an alternative. I think this would be a good idea if there were many articles which are obsolete, in which case I would redirect to a separate overview article covering all obsolete troubleshooting articles which would then describe why the details were removed.

For the current case of two articles to be updated I prefer to leave them in place and simplify the text as I suggested. It is a matter of opinion though, so thank you for giving your views!

Ein-Tim commented 1 year ago

@MikeMcC399

I see your point and agree that it might be best to go ahead just updating these articles as you suggested.

I just thought of something else: Maybe it would make sense to ask in the CWA documentation repository for an official end of life of support for the 1.x releases as soon as version 3.0 has been released?

Do you have any issue reg. this in planning or is this an issue I could open?

MikeMcC399 commented 1 year ago

@Ein-Tim

Maybe it would make sense to ask in the CWA documentation repository for an official end of life of support for the 1.x releases as soon as version 3.0 has been released?

Do you have any issue reg. this in planning or is this an issue I could open?

MikeMcC399 commented 1 year ago
Ein-Tim commented 1 year ago

@MikeMcC399

If there is no answer by the time 3.0 is released maybe it would make sense to open a separate issue for it.

Agreed! Thanks!