Cwa-documentation: [CWA-Documentation-Github] Wiki packages missing information for new packages in releases 1.5 and later

[MikeMcC399]

Where to find the issue

https://github.com/corona-warn-app/cwa-app-android/wiki/5-Packages

Describe the issue

The Wiki document 5-Packages referred to by https://github.com/corona-warn-app/cwa-app-android/blob/release/1.5.x/README.md does not describe any of the new packages introduced by release/1.5.x.

Suggested change

Add a paragraph of explanation to 5-Packages for each of the new packages:

• appconfig
• diagnosiskeys
• environment
• playbook
• submission
• verification

---

Internal Tracking ID: EXPOSUREAPP-4290

[MikeMcC399]

With the release of 1.7.x there are even more packages which are not documented in https://github.com/corona-warn-app/cwa-app-android/wiki/5-Packages e.g.

• bugreporting
• deadman

[dsarkar]

FYI: Internal Tracking ID: EXPOSUREAPP-4290 DS

---

Corona-Warn-App Open Source Team

[MikeMcC399]

It would be interesting to see documentation for the deadman package (see also comment in https://github.com/corona-warn-app/cwa-documentation/issues/442#issuecomment-735260084).

Reading the Android code at https://github.com/corona-warn-app/cwa-app-android/tree/main/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/deadman I think it fires the following notification if there hasn't been a successful exposure check for more than 36 hours. Is that correct?

risk_details_deadman_notification_body
"Please remember to open the Corona-Warn-App regularly to check your risk status."

(Note: there is currently an issue that the notification is truncated on Android. See https://github.com/corona-warn-app/cwa-app-android/issues/1850.)

[Ein-Tim]

I think it fires the following notification if there hasn't been a successful exposure check for more than 36 hours. Is that correct?

Yes this is correct.

[MikeMcC399]

The packages in CWA Android 1.10.1 according to the directories listed in https://github.com/corona-warn-app/cwa-app-android/tree/main/Corona-Warn-App/src/main/java/de/rki/coronawarnapp are as follows. Many of them are not documented in https://github.com/corona-warn-app/cwa-app-android/wiki/5-Packages.

Package |
--- |
appconfig |
bugreporting |
contactdiary |
deadman |
diagnosiskeys |
environment |
exception|
http |
nearby|
notification |
playbook |
receiver|
risk|
service|
sharing|
storage|
submission |
task |
tracing |
ui|
update|
util|
verification |
worker |

The following packages are documented in https://github.com/corona-warn-app/cwa-app-android/wiki/5-Packages, however they are not present in https://github.com/corona-warn-app/cwa-app-android/tree/main/Corona-Warn-App/src/main/java/de/rki/coronawarnapp.

Package |
--- |
timer
transaction |

[dsarkar]

Thanks, updated Internal Tracking ID: EXPOSUREAPP-4290. DS

[MikeMcC399]

It seems like new features and enhancements are not being documented at all. There is no mention of the

• Contact Journal nor of the
• Statistics

in the community-facing documentation. 😞

[MikeMcC399]

The contents of the Wiki 5 Packages has not been updated since June 12, 2020.

If there is no intention of keeping this document up to date, I suggest adding text at the top of Wiki 5 Packages to say that the Wiki is not being maintained and it reflects the packages which were part of the original release in June 2020 only.

[dsarkar]

@MikeMcC399 ok, I will suggest this to the devs.

[Ein-Tim]

Since we're in the documentation repo here, that's how it looks on iOS:

https://github.com/corona-warn-app/cwa-app-ios/wiki was last updated on 24.08.2020. I'm quite sure that the iOS wiki is also missing some new things, but I can't check it at the moment.

For iOS there's also a GitHub Pages deployment: https://corona-warn-app.github.io/cwa-app-ios/
It was last updated on 22.10.2020.
I don't think the infos there are outdated but are also missing some parts.

[MikeMcC399]

https://github.com/corona-warn-app/cwa-app-android/wiki/5-Packages has been deleted.

[dsarkar]

@MikeMcC399 Thanks. Will try to figure out why that happened.

---

Corona-Warn-App Open Source Team