Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Glossary #1483

Merged
merged 11 commits into from
Jul 15, 2021
Merged

Improve Glossary #1483

merged 11 commits into from
Jul 15, 2021

Conversation

Ein-Tim
Copy link
Contributor

@Ein-Tim Ein-Tim commented Jul 11, 2021

This PR addresses the false statements mentioned in #1477 (comment).

This is a follow up to PR #1478.

This commit addresses the false statements mentioned in #1477 (comment).
@Ein-Tim Ein-Tim requested a review from a team July 11, 2021 14:02
@Ein-Tim
Copy link
Contributor Author

Ein-Tim commented Jul 11, 2021

Please don't merge this yet, I have one more thing to address.

@MikeMcC399
Copy link
Contributor

@Ein-Tim

Please don't merge this yet, I have one more thing to address.

You could set the PR to Draft if you don't want it reviewed or merged yet.

@Ein-Tim Ein-Tim marked this pull request as draft July 11, 2021 18:21
@Ein-Tim Ein-Tim marked this pull request as ready for review July 11, 2021 19:09
@Ein-Tim
Copy link
Contributor Author

Ein-Tim commented Jul 11, 2021

I've now addressed one more inaccuracy and this is PR is ready to merge @dsarkar!

@Ein-Tim Ein-Tim requested review from dsarkar and removed request for a team July 11, 2021 19:10
src/data/faq_de.json Outdated Show resolved Hide resolved
Copy link
Contributor

@MikeMcC399 MikeMcC399 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change title regarding validity (Gültigkeit).

Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
Copy link
Contributor

@GisoSchroederSAP GisoSchroederSAP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We cannot strictly specify "Gültigkeit eines Impfzertifikats", sorry. The validity really depends on the type of the certificate (vaccination certificate, test certificate, and recovery certificate). The article uses the vaccination certificate as an example only. But we need to enhance this article by the different validity periods for the different types. This is already in preparation.

Maybe it's better to call it "Gültigkeit eines COVID-Zertifikats", which would be correct and covers all types.

@Ein-Tim
Copy link
Contributor Author

Ein-Tim commented Jul 11, 2021

Okay, thanks for the feedback @GisoSchroederSAP! I'll revert the change for now, but please don't forget to adjust this, especially if every certificate has a different validity.

@Ein-Tim
Copy link
Contributor Author

Ein-Tim commented Jul 11, 2021

So, reverted. I can adjust the wording tomorrow (if needed). But tbh, the entry really is all about vaccination certificates, so why can't we leave "Impfzertifikat" there for now and only change it once the entry was made more general? Please think about it again @GisoSchroederSAP.

Thank you for your work, have a good night!

@GisoSchroederSAP
Copy link
Contributor

Basically, the intention of the whole article is to explain the proper separation of the "technical" validity from the "effective" validity.
And yes, at the time of writing this, I only had a sample of an vaccination certificate at hand.
In fact, the whole explanation could have been done as well with a travel passport and trans "translated" to certificates in general - but my concern is, most of the users are just focussed on the vaccination certificate.
As mentioned earlier: I am totally fine to name the article "Gültigkeit eines COVID-Zertifikats" 'cause COVID-Zertifikat covers all three types of certificates.

@Ein-Tim
Copy link
Contributor Author

Ein-Tim commented Jul 12, 2021

As mentioned earlier: I am totally fine to name the article "Gültigkeit eines COVID-Zertifikats" 'cause COVID-Zertifikat covers all three types of certificates.

Yes, but then the title covers all three types but not the entry, so this is (in my opinion) not really helpful for the user.

But I'm fine with that, I'll change the title to "Gültigkeit eines COVID-Zertifikats" and I'm sure you'll come up with a more general explanation then.

Thanks for your feedback.

This commit changes the title of a glossary entry.
@Ein-Tim
Copy link
Contributor Author

Ein-Tim commented Jul 12, 2021

Title changed, ready for merge (from my POV)!

@MikeMcC399
Copy link
Contributor

MikeMcC399 commented Jul 12, 2021

  1. I suggest to change the title to
    "Gültigkeit eines EU digitalen COVID-Zertifikats"
    to match the official name on the certificate documents.

  2. Before the example about the Impfzertifikat starts (before the text "In dem Zertifikat"), then add a sub-header in bold which says:
    Impfzertifikat
    otherwise the reference "in diesem Falle" has no meaning.

  3. I am confused about the paragraph starting "Die Check App". Why is that here in a glossary about the Corona-Warn-App? Shouldn't the reference in this and the following paragraph be to the Corona-Warn-App and not to the Check App? In any case there is no app with this exact name. If the CovPassCheck-App is meant, then the proper name of this app should be used (see Google Play Store description).

  4. The logic in the last sentence "Unerheblich davon..." is not so good and the sentence could be made simpler and more understandable.

  5. Concerning 3) and 4) I don't think that a Glossary should refer to an app at all. I suggest replacing the final two paragraphs with something like:
    "Ein Zertifikat behält seine gesamte Gültigkeit bis entweder die technische Gültigkeit oder die fachliche Gültigkeit abläuft."

@Ein-Tim Ein-Tim changed the title Correct untrue statements in Glossary Improve Glossary Jul 12, 2021
This commit further improves the glossary entry "Gültigkeit eines COVID-Zertifikats".
@Ein-Tim
Copy link
Contributor Author

Ein-Tim commented Jul 12, 2021

  1. I suggest to change the title to
    "Gültigkeit eines EU digitalen COVID-Zertifikats"
    to match the official name on the certificate documents.

Done in a8374a5.

  1. Before the example about the Impfzertifikat starts (before the text "In dem Zertifikat"), then add a sub-header in bold which says:
    Impfzertifikat
    otherwise the reference "in diesem Falle" has no meaning.

Done in a8374a5 too, but now I see the problem that the second bullet point is a bit out of context?

Bildschirmfoto 2021-07-13 um 00 03 36

  1. Concerning 3) and 4) I don't think that a Glossary should refer to an app at all. I suggest replacing the final two paragraphs with something like:
    "Ein Zertifikat behält seine gesamte Gültigkeit bis entweder die technische Gültigkeit oder die fachliche Gültigkeit abläuft."

Also done in a8374a5.

@Ein-Tim
Copy link
Contributor Author

Ein-Tim commented Jul 12, 2021

@GisoSchroederSAP Please take another look if these changes are fine with you. Thanks!

@Ein-Tim Ein-Tim requested a review from GisoSchroederSAP July 12, 2021 22:08
@MikeMcC399
Copy link
Contributor

@Ein-Tim
Thanks for making the changes! I think the article is now much more understandable than it was before.

If @GisoSchroederSAP can soon add the information about the other types of certificate that would be perfect.

@Ein-Tim
Copy link
Contributor Author

Ein-Tim commented Jul 14, 2021

Since Giso (not mentioning him here intentionally) said he will take a (well deserved) summer break, I guess we won't here feedback from him in the next few weeks.

So maybe @dsarkar, could you take this over and get an approval on the changes? If not, please apply the on hold label here and we'll wait for Giso to return.

Thanks everyone, enjoy the evening and sleep well! 😴

Copy link
Contributor

@GisoSchroederSAP GisoSchroederSAP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my perspective, all changes are okay to be accepted; the first commented proposal could be even more polished, but I don't insist here.
Thanks for having an eye on our Glossary.

src/data/faq_de.json Outdated Show resolved Hide resolved
Co-Authored-By: GisoSchroederSAP <69585203+GisoSchroederSAP@users.noreply.github.com>
@dsarkar dsarkar merged commit bc5d8af into corona-warn-app:master Jul 15, 2021
@dsarkar
Copy link
Member

dsarkar commented Jul 15, 2021

@Ein-Tim @MikeMcC399 @GisoSchroederSAP Thanks! Merged.

@Ein-Tim Ein-Tim deleted the fix/glossary-issues branch July 15, 2021 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants