Improve site-readiness for translations #112

keunes · 2021-11-10T08:02:27Z

Contributes to #111

_data/languages.yml

_documentation/getting-started/subscribe.md

_includes/breadcrumbs.html

_includes/documentation-card.html

_documentation/automation.md

_documentation/podcasters-hosters/list-podcast.md

_i18n/en.yml

ByteHamster

A few things I noticed when skimming (not a detailed review yet)

_data/languages.yml

_i18n/en/general/license.md

contribute.html

_data/navbar.yml

_i18n/en/documentation/queue/lock.md

keunes · 2021-11-15T18:38:10Z

Hi @MichaelCurrin
Thanks again for your help with the simplification of the language menu over on the Jekyll forum. This is the PR I was working on (there's one commit that moves around a lot of files, which might be a bit distracting of the other changes). Much appreciated if you're willing to have a look, thanks a lot!

_includes/nav_languages.html

keunes · 2021-12-10T22:48:16Z

Hi @ByteHamster

Did you still want to have a look? I'd like to merge it soon so this is out of the way :-)

I've received help from an expert and it runs smoothly locally and on Netlify, so I'm comfortable also merging this without your review.

If we want a cleaner history, everything but b2574f7 could be squashed.

ByteHamster · 2021-12-12T16:13:56Z

Please remove the German language from the menu. The translations there are just placeholders and not actual text. We don't want that to be indexed by Google.
The search function does not show the titles. I think this can be fixed in search.json
You renamed a link (auto_rewind to auto-rewind). There should be a redirect to the new URL.
Please explicitly mention the language in included images. When translating the pages, we then need to pay attention on either creating the translated images or keeping the English images. Like it currently is, we always use the localized version, even if it does not exist. Alternatively, maybe it would be possible to write a function that checks if the image exists in the target language and if it doesn't, just falls back to English. That would be the easiest method - then we can even add 
- queue/lock.md
- general/beta.md
- general/gpodder.md
- download.md
Translating the privacy policy is fine (with the "English prevails" sentence) but I still think that translating the license is not a good idea. I don't think there is much use for it and it could lead to problems. Licenses are worded carefully for a reason.

keunes · 2021-12-16T23:20:56Z

Thanks again @ByteHamster for the feedback!

You renamed a link (auto_rewind to auto-rewind). There should be a redirect to the new URL.

It's a sub-page in the documentation. If for every update we ever make to the documentation requires a redirect, it might get a rather long list. I think such not-prominent pages do not deserve redirects.

I still think that translating the license is not a good idea

The localised file has  above the license text, so it will not be translated.

I just discovered that there's a 'bug' in the menu rendering: the forum URL is prepended by the localised site URL. Once that's fixed as well, I'll commit the changes.

keunes · 2021-12-17T08:24:47Z

Ok, changes committed :)

_documentation/general/beta.md

ByteHamster · 2021-12-19T16:21:55Z

_i18n/en/documentation/general/gpodder.md

+{% include image.html
+   alt="
+       <!-- mdpo-enable-next-line -->
+       devices
+
+       "
+   loc="/assets/images/documentation"
+   file="gpodder-devices.png"
+%}


Hmm this is indeed quite a bit of text. Would it be possible to only include the URL, not the full image? Or does that add whitespaces? Then we do not need the mdpo enable/disable code.

Something like:

![devices]({% include localized-documentation-image file="gpodder-devices.png" %})

Downside is that there's a bigger chance that translators mess up, as they see the whole code rather than only the translatable text. Not sure whether risk of translators making a mistake is smaller/bigger than site code contributors. So I can change in line with your suggestion :)

It works but the URLs must be captured first, otherwise the images don't work, indeed due to spaces:

{% capture GP-url %}{% include image-url.liquid folder='badges' file='get-it-on-google-play.png' %}{% endcapture %} [<img alt="Get it on Google Play" src="{{ GP-url | strip }}" height="80px"/>](https://play.google.com/store/apps/details?id=de.danoeh.antennapod) ![get on GP]({{ GP-url | strip }})

full image url only

capture only when code otherwise becomes hard to read and in lists always

translators deal only with text to translate see & have to copy md tag (html tag on download page)

code complexity more (particularly in md files) less

I'm inclined so use both includes: one for more full html image tags with class & size, one for url-only for md image tags.

Hmm, having two different includes could be more confusing than helpful for contributors. I would say let's just keep it the way it is now :)

antennapod-bot · 2021-12-22T21:18:25Z

This pull request has been mentioned on AntennaPod Forum. There might be relevant details there:

https://forum.antennapod.org/t/whos-wrong-antenna-or-guardian/1573/16

ByteHamster

Sorry for the late reply and so much back-and-forth with this PR. Looks good to me now, ready to merge :)

ByteHamster · 2021-12-23T09:03:48Z

_i18n/en/documentation/general/gpodder.md

+{% include image.html
+   alt="
+       <!-- mdpo-enable-next-line -->
+       devices
+
+       "
+   loc="/assets/images/documentation"
+   file="gpodder-devices.png"
+%}


Hmm, having two different includes could be more confusing than helpful for contributors. I would say let's just keep it the way it is now :)

keunes · 2021-12-23T09:45:00Z

Yeey. Thanks a lot for the feedback!

keunes · 2021-12-23T10:08:45Z

Ah, actually: do you think we should/could squash into three commits?

Everything before
b2574f7 (where all the text gets moved to different files)
Everything after

With the feedback I made quite a few subsequent changes on the same things - merging stuff would make it easier to understand the changes. But this one commit is just a lot of moving text around which would make reading history harder.

No idea how to squash certain commits only, though (only know on web you can squash all).

ByteHamster · 2021-12-23T11:17:18Z

31b8eb9 moves a lot of files, too. I squashed the last few commits that just said "review corrections", "final corrections" etc ;)

simplify lang-menu data

ae8e500

keunes changed the title ~~simplify lang-menu data~~ Make site ready for semi-automated translations Nov 10, 2021

ByteHamster reviewed Nov 10, 2021

View reviewed changes

_data/languages.yml Outdated Show resolved Hide resolved

Localise documentation & footer update

31b8eb9

ByteHamster reviewed Nov 11, 2021

View reviewed changes

_documentation/getting-started/subscribe.md Outdated Show resolved Hide resolved

_includes/breadcrumbs.html Outdated Show resolved Hide resolved

_includes/documentation-card.html Outdated Show resolved Hide resolved

Simplify & correct documentation titles & lang selector

f4e9a44

ByteHamster reviewed Nov 13, 2021

View reviewed changes

_documentation/automation.md Show resolved Hide resolved

keunes added 7 commits November 13, 2021 13:05

localise breadcrumb & card links

d3b1cc8

localise images

a30fb48

simplify navbar localisation

ed63f4a

reorganise md translation files

b2574f7

localise blog post urls

06ade7e

includes updates

73babe5

localise accessibility labels

2d5cbbd

keunes requested a review from ByteHamster November 13, 2021 22:44

keunes marked this pull request as ready for review November 13, 2021 22:47

keunes changed the title ~~Make site ready for semi-automated translations~~ Improve site-readiness for translations Nov 13, 2021

keunes commented Nov 13, 2021

View reviewed changes

_documentation/podcasters-hosters/list-podcast.md Outdated Show resolved Hide resolved

_i18n/en.yml Outdated Show resolved Hide resolved

_i18n/en.yml Outdated Show resolved Hide resolved

ByteHamster reviewed Nov 14, 2021

View reviewed changes

_data/languages.yml Outdated Show resolved Hide resolved

_i18n/en/general/license.md Show resolved Hide resolved

contribute.html Outdated Show resolved Hide resolved

_data/navbar.yml Outdated Show resolved Hide resolved

_i18n/en/documentation/queue/lock.md Outdated Show resolved Hide resolved

MichaelCurrin reviewed Nov 16, 2021

View reviewed changes

_includes/nav_languages.html Outdated Show resolved Hide resolved

This was referenced Nov 17, 2021

Request: replace url inside MD tag with <link> mondeja/mdpo#203

Closed

Adjust permalink approach #115

Open

ByteHamster reviewed Dec 19, 2021

View reviewed changes

ByteHamster approved these changes Dec 23, 2021

View reviewed changes

Review corrections

a9cb33e

ByteHamster force-pushed the translation-readyness branch from 93f47f2 to a9cb33e Compare December 23, 2021 11:15

keunes merged commit 7221575 into master Dec 23, 2021

keunes deleted the translation-readyness branch December 23, 2021 14:22

ByteHamster mentioned this pull request Jan 1, 2022

Fix Twitter card image #124

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve site-readiness for translations #112

Improve site-readiness for translations #112

keunes commented Nov 10, 2021 •

edited

Loading

ByteHamster left a comment

keunes commented Nov 15, 2021

keunes commented Dec 10, 2021 •

edited

Loading

ByteHamster commented Dec 12, 2021 •

edited by keunes

Loading

keunes commented Dec 16, 2021

keunes commented Dec 17, 2021

ByteHamster Dec 19, 2021

keunes Dec 20, 2021

keunes Dec 21, 2021 •

edited

Loading

ByteHamster Dec 23, 2021

antennapod-bot commented Dec 22, 2021

ByteHamster left a comment

ByteHamster Dec 23, 2021

keunes commented Dec 23, 2021

keunes commented Dec 23, 2021 •

edited

Loading

ByteHamster commented Dec 23, 2021

	full image	url only
capture	only when code otherwise becomes hard to read and in lists	always
translators	deal only with text to translate	see & have to copy md tag (html tag on download page)
code complexity	more (particularly in md files)	less

Improve site-readiness for translations #112

Improve site-readiness for translations #112

Conversation

keunes commented Nov 10, 2021 • edited Loading

ByteHamster left a comment

Choose a reason for hiding this comment

keunes commented Nov 15, 2021

keunes commented Dec 10, 2021 • edited Loading

ByteHamster commented Dec 12, 2021 • edited by keunes Loading

keunes commented Dec 16, 2021

keunes commented Dec 17, 2021

ByteHamster Dec 19, 2021

Choose a reason for hiding this comment

keunes Dec 20, 2021

Choose a reason for hiding this comment

keunes Dec 21, 2021 • edited Loading

Choose a reason for hiding this comment

ByteHamster Dec 23, 2021

Choose a reason for hiding this comment

antennapod-bot commented Dec 22, 2021

ByteHamster left a comment

Choose a reason for hiding this comment

ByteHamster Dec 23, 2021

Choose a reason for hiding this comment

keunes commented Dec 23, 2021

keunes commented Dec 23, 2021 • edited Loading

ByteHamster commented Dec 23, 2021

keunes commented Nov 10, 2021 •

edited

Loading

keunes commented Dec 10, 2021 •

edited

Loading

ByteHamster commented Dec 12, 2021 •

edited by keunes

Loading

keunes Dec 21, 2021 •

edited

Loading

keunes commented Dec 23, 2021 •

edited

Loading