FAQ updates from main repo #242
Labels
No labels
about page
bug
community page
documentation
donate page
duplicate
enhancement
feature page
good first issue
Google Season of Docs
help wanted
invalid
landing page
news page
question
support page
wontfix
No milestone
No project
No assignees
3 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference: organicmaps/website#242
Loading…
Add table
Reference in a new issue
No description provided.
Delete branch "faq-updates-from-main-repo"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Copied FAQ from https://github.com/organicmaps/organicmaps/blob/master/data/faq.html Nothing changed.
Added service page
/faq/translation_statuswith all FAQ questions with translations as a table to track statuses.FAQ categories need translations:
I think Roman's PR #115 could be closed.
Update 2022-06-17
Added "Edit on GitHub" link to every FAQ page.
Should we translate link text?
Should we add the link to every page (now only FAQ pages have it)?
Should we move link to top? For example https://sphinx-rtd-theme.readthedocs.io/en/stable/ have github link on top.
Update 2022-06-18
Page
/faq/translation_statusnow have coloring depending on last update date. Yellow cell color means thatupdatedfield is missing. Red cell means that translated page is older than English page.Coloring was implemented with Javascript 'cause Zola/Tera doesn't support strings or dates comparison. Only numbers could be compared with
<operator 😕Update 2022-06-21
FAQ sections are now translated in
config.toml. So instead offaq: ["Map Editing"]we usefaq: ["editing"]for all languages. And actual UI title is loaded fromfaq_section_editingstring constant.New translation constants:
faq_section_app = "App"faq_section_bookmarks = "Bookmarks and Tracks"faq_section_editing = "Map Editing"faq_section_map = "Map"faq_section_tts = "Voice Directions"Update 2022-06-22
Updated
README.mdin FAQ section to reflect latest changes.Update 2022-06-28
Updated
/faq/translation_statuspage to work without JavaScript.What's that asterisk
*symbol?Should we synchronize
organicmaps/data/faq.htmlfile with this repo? Some Python script to copy text from MD to HTML?Deploying organicmaps with
Cloudflare Pages
9f182c0View logs
Thanks a lot for your work! I love the translation status page! Is it possible in addition to compare FAQ article dates, and mark translations as outdated if they were not changed after the English md file was edited?
Left some comments, it would be great to also sync ru, uk and other languages.
@strump please confirm that for iOS and Android three dots are present.
Will it work?
Is description used for SEO? It is important to add some keywords here.
It's better to describe two ways to import as separate ones:
This is not actual anymore and can be removed. Download Manager is not used.
Fixed
Fixed
Fixed
Fixed
Removed the paragraph
Fixed
Fixed
Fixed
Fixed
Fixed
Fixed
Fixed
Fixed
Fixed
Fixed
Fixed
Fixed
Confirming: three dots are present on Android and iOS (iPadOS).
Description is used to generate HTML tags:
which is good for SEO and link preview. But if it's empty then FAQ body is used instead.
Should I duplicate
titleintodescription?config.tomlwriting:But it didn't work. Looks like we can use
trans()code only in Markdown body.content/faq/_index.##.mdfiles for all languages. But if there are no taxonomies then Zola doesn't generate/##/faq/page and user will see error page:No, title duplication is not helpful. More unique/relevant keywords are beneficial. Either autogeneration from the body or manual new words should be used.
Is there any preview page on Cloudflare? I can't find a link.
@rtsisyk try https://faq-updates-from-main-repo.organicmaps.pages.dev
Did you see this block?
@strump you can use DeepL as the initial version. And then tag our translate groups on Github (for selected languages only) to review automated translations.
@biodranik I added
descriptionproperty to every FAQ question in English. See commit 52e0fa6Please review
Updated bookmarks and tracks import guide. Please review
Updated FAQ description in
content/faq/_index.##.mdfiles using DeepL.But I don't know how to translage 'F.A.Q.' menu item into German. Please review
It was hidden. Thanks!!!
LGTM. Thanks for finally getting FAQ in the right place.
Great, thanks! A few comments.
@organicmaps/translations can you please review translations in your language, and suggest full translations if your language is missing?
@ -405,6 +428,7 @@ language = "Русский"language-word = "Язык"name = "Название"token = "Токен"@ -444,3 +471,4 @@name = "Ad"token = "Belirteç"[languages.uk]@ -488,3 +520,4 @@edit-on-github = "GitHubi redigeerimine"engines = "Supported TTS Engines"faq-menu-title = "F.A.Q."install-appgallery = "Paigalda Organic Maps Huawei AppGallery'st"@ -0,0 +1,21 @@---title: Що робити, якщо додаток несподівано закрився або вийшов з ладу?description: ""What is the benefit of using English taxonomy everywhere instead of localized one? Isn't a localized one (present in the URL) improving the SEO by catching relevant search requests?
A translator can add a translation here, just in one place, without referencing something in the config. Isn't it simpler?
I think it's a typo, it should be removed.
@ -0,0 +1,21 @@---title: Comment importer des signets?description: ""nit: Can the key contain spaces? "bookmarks and tracks"? Or dashes? Then it would be easier to translate properly (and a better SEO).
Awesome, thanks!
@ -0,0 +1,21 @@---title: Що робити, якщо додаток несподівано закрився або вийшов з ладу?description: ""I think that all FAQ translations should be in a single file for simplicity. If we decide to rename "Map Editing" to "Map Changes" this could be done in a config without touching MD files. Also typos could lead to extra sections. If user writes
"Bookmarks and Tracks"and"Bookmark and track"those would be treated as two different taxonomies.Disadvantage of such approach: we need to translate all strings even if there is no FAQ pages. For example there is no TTS FAQ page in German but I had to add
faq_section_ttstranslation to German language.And if we add new section such as "ios" it should be translated to all FAQ languages or we'll get Zola errors.
@ -0,0 +1,21 @@---title: Comment importer des signets?description: ""Currently I use simple concatenation
"faq_section_" + taxonome_termto get translation constantfaq_section_tts. We can allow spaces and hyphens using Zola built-in regex-replace function.@ -444,3 +471,4 @@name = "Ad"token = "Belirteç"[languages.uk]Removed extra empty line
@ -444,3 +471,4 @@name = "Ad"token = "Belirteç"[languages.uk]Removed empty line
@ -488,3 +520,4 @@edit-on-github = "GitHubi redigeerimine"engines = "Supported TTS Engines"faq-menu-title = "F.A.Q."install-appgallery = "Paigalda Organic Maps Huawei AppGallery'st"Removed empty line
@ -488,3 +520,4 @@edit-on-github = "GitHubi redigeerimine"engines = "Supported TTS Engines"faq-menu-title = "F.A.Q."install-appgallery = "Paigalda Organic Maps Huawei AppGallery'st"Removed empty line
@ -405,6 +428,7 @@ language = "Русский"language-word = "Язык"name = "Название"token = "Токен"Fixed
@ -0,0 +1,21 @@---title: Comment importer des signets?description: ""So this key should also match the directory name where pages are located, right?
@ -0,0 +1,21 @@---title: Що робити, якщо додаток несподівано закрився або вийшов з ладу?description: ""The comparison of two approaches:
Pros:
Cons:
Pros:
Cons:
aliassupport here, we may need to add manual aliases in this case)@strump did I miss something? So far the benefits from the second approach look worth it, no?
Thanks @strump ! A few comments.
Should it be capitalized? e.g. Map, App?
Does it make sense to mention that for other languages taxonomies should be translated for better SEO?
Is it still needed?
@strump ^^^
Let's mass-replace the string in all translations and add KMB everywhere.
Also should be mass-replaced.
@ -0,0 +40,4 @@<body>{% set all_categories = get_taxonomy(kind='faq', lang = 'en') %} {# Use English as list of all FAQ categories and questions #}{% set faq_languages = ["ru", "de", "fr", "it", "pl", "pt", "pt-BR", "tr", "uk", "zh-Hans"] %} {# Predefined list of translation languages #}Can the list be retrieved dynamically?
Removed.
Renamed
faq/map/can-find-positiontofaq/map/can-not-find-positionUpdated "Taxonomy value" column
Added translated taxonomies samples:
/es/faq/aplicacion/and/de/faq/karte/Added KMB to the list of supported formats all over the FAQ.
Translated button "Import Bookmarks and Tracks" according to strings.txt
But Android is still mentioned in Espanol, German and other languages. We need to ask for translation.
Added
KMBto the list of supported formats all over the FAQ.@ -0,0 +40,4 @@<body>{% set all_categories = get_taxonomy(kind='faq', lang = 'en') %} {# Use English as list of all FAQ categories and questions #}{% set faq_languages = ["ru", "de", "fr", "it", "pl", "pt", "pt-BR", "tr", "uk", "zh-Hans"] %} {# Predefined list of translation languages #}I can't find how to implement this with Zola templates.
@ -0,0 +40,4 @@<body>{% set all_categories = get_taxonomy(kind='faq', lang = 'en') %} {# Use English as list of all FAQ categories and questions #}{% set faq_languages = ["ru", "de", "fr", "it", "pl", "pt", "pt-BR", "tr", "uk", "zh-Hans"] %} {# Predefined list of translation languages #}ACK, we'll come to it later, now manual editing is good enough.
Thanks! I've fixed other langs.
@strump thank you for your titanic work! The next step is to add necessary translations to existing articles, and add new FAQ articles.