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

Fix some screenshot JSON issues #2454

Merged
merged 4 commits into from
Jun 1, 2022
Merged

Fix some screenshot JSON issues #2454

merged 4 commits into from
Jun 1, 2022

Conversation

Marcono1234
Copy link
Contributor

Fixes some screenshot JSON issues. This is not extensive; there are still remaining issues not fixed by this pull request:

  • Incorrect alt texts (Generate screenshot alt texts automatically (or omit them) #2453)
  • Usage of incorrect version screenshots
    E.g. version 2.10 using screenshots of version 2.9 (maybe in some cases this is acceptable, since screenshots from the correct version are missing).
  • Usage of assets/img/faq/hr_en / assets/img/faq/hr_de
    This is related to the above. These files are not part of the versioned screenshot folders, therefore either they will become stale, or when updated they will be incorrect for the archived versions referencing them, because back then the screen looked differently.
  • Usage of wrong device type
    E.g. the Android screenshots page showing iOS screenshots.

I have created a proof of concept GitHub workflow in https://github.com/Marcono1234/cwa-website/tree/marcono1234/screenshots-json-validation (not properly cleaned up yet) for checking the JSON files for such errors. It also reports the problems in a pull request comment, as seen here (note that normally it would only show some of the issues if the screenshot JSON files were modified). Please let me know if you are interested in this, but keep in mind that the validation scripts for this might add a maintenance burden, and might therefore not be justified for this small improvement they add.

@Marcono1234 Marcono1234 requested a review from a team February 20, 2022 22:13
@@ -169,7 +169,7 @@
},
{
"title": "Check certificates for validity before a trip",
"anchor": "ios_check_validity_certificate",
"anchor": "android_check_validity_certificate",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Arguably this is not much better because the screenshots below are actually for iOS; however this is the Android section.
Maybe this section should be removed completely for Android then, in case no screenshots exist for it?

@@ -169,7 +169,7 @@
},
{
"title": "Zertifikate vor einer Reise auf Gültigkeit prüfen",
"anchor": "ios_check_validity_certificate",
"anchor": "android_check_validity_certificate",
Copy link
Contributor Author

@Marcono1234 Marcono1234 Feb 20, 2022

Choose a reason for hiding this comment

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

@Ein-Tim
Copy link
Contributor

Ein-Tim commented Feb 21, 2022

I support all you say and your work to 100%, especially the workflow you created!

However, it was agreed to not change old screenshot versions, see #1660 (comment).

You could certainly discuss with the maintainers whether this agreement could be thought of if there is an automatic checking process, etc.

@dsarkar dsarkar self-assigned this Mar 9, 2022
@dsarkar dsarkar added the screenshots New Screenshots provided label Mar 9, 2022
@Ein-Tim
Copy link
Contributor

Ein-Tim commented Mar 9, 2022

@larswmh Did you speak to @svengabr whether it is OK to change old screenshot versions?

@Ein-Tim
Copy link
Contributor

Ein-Tim commented May 13, 2022

Dear Open-Source-Team ( @dsarkar@larswmh),

could you please let us know how you plan to proceed with this PR? If it won't be merged, it should be closed.

@Ein-Tim
Copy link
Contributor

Ein-Tim commented May 20, 2022

Hey @svengabr, please decide how to proceed with this PR. Thanks.

@dsarkar
Copy link
Member

dsarkar commented Jun 1, 2022

@Marcono1234 Thanks for the PR, sorry for the delay!

@dsarkar dsarkar merged commit 37c86b6 into corona-warn-app:master Jun 1, 2022
larswmh added a commit that referenced this pull request Jun 1, 2022
@Marcono1234 Marcono1234 deleted the screenshot-json-fixes branch June 1, 2022 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
screenshots New Screenshots provided
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants