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

FAQ updates from main repo #242

Merged
merged 36 commits into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
f52d107
Added F.A.Q. question "Some places are missing on the map or have wro…
strump Jun 10, 2024
287cc1b
Added F.A.Q. question "The app can't find my position on the map" fro…
strump Jun 10, 2024
5c0ff3f
Modified taxonomy from "Map Editing" to "Map"
strump Jun 10, 2024
a9fe924
Added F.A.Q. question "I can't download (update) maps" from https://g…
strump Jun 10, 2024
718f50d
Moved 2 FAQ questions to "map" subfolder
strump Jun 10, 2024
c2da37c
Added F.A.Q. question "Search cannot find a place on the map" from ht…
strump Jun 10, 2024
2ddf7d5
Renamed language from "zh" to "zh-Hans".
strump Jun 10, 2024
b781799
Explicit is better than implicit. Missing FAQ translation should rais…
strump Jun 11, 2024
db5dc23
Added debug page `/faq/translation_status` with the table of all FAQ …
strump Jun 11, 2024
8c7a22b
Added F.A.Q. question "What can I do if the app has stopped/crashed?"…
strump Jun 11, 2024
5d27770
Added F.A.Q. question "How to share (export) bookmarks?" from https:/…
strump Jun 12, 2024
7b09e83
Added F.A.Q. question "How to import bookmarks?" from https://github.…
strump Jun 12, 2024
0eaa024
Small updates to content/faq/translation_status.md
strump Jun 12, 2024
92d931b
Changed order for "How to import bookmarks?" question
strump Jun 12, 2024
94aaa23
Changed order for "The app can't find my position on the map" and "Se…
strump Jun 12, 2024
aef97f2
Translated FAQ categories into Russian
strump Jun 12, 2024
eab5bbd
Translated FAQ categories into Ukrainian
strump Jun 12, 2024
e2e50a5
Translated FAQ categories into Ukrainian and Espanol
strump Jun 12, 2024
8fb295c
Showing updated date at translation_status.html page.
strump Jun 14, 2024
407d6ba
Fixed github edit link
strump Jun 17, 2024
cc41607
Inserted last updated date to new FAQ pages.
strump Jun 17, 2024
7f966cb
Updated English questions according to PR suggestions.
strump Jun 17, 2024
20a4de6
Updated question "How to import bookmarks and tracks in KML, KMZ, or …
strump Jun 19, 2024
20b45d2
Translated "Frequently Asked Questions" and "F.A.Q." to supported lan…
strump Jun 19, 2024
8fb3f8e
Added "description" property to FAQ pages in English
strump Jun 20, 2024
19c24af
Updated FAQ description with DeepL translation
strump Jun 20, 2024
e62854b
Moved FAQ sections into config.toml translations.
strump Jun 21, 2024
ccb339a
Updated README.md according to latest changes.
strump Jun 22, 2024
bf655e0
Removed extra spaces. Fixed cases
strump Jun 22, 2024
1a31262
Implemented FAQ status page without JavaScript
strump Jun 28, 2024
e9ffd1a
Revert "Moved FAQ sections into config.toml translations."
strump Jul 4, 2024
cf37fe9
Fixed taxonomies names
strump Jul 4, 2024
7aed8ed
Apply suggestions from code review.
strump Jul 9, 2024
69bd99a
[faq] Removed Android mention from import
biodranik Jul 9, 2024
f8056c7
Translated Edit on Github
biodranik Jul 9, 2024
9f182c0
Minor styling for Edit on GitHub button
biodranik Jul 9, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,34 +48,33 @@ Each MD page in `/faq/` has one or more taxonomy defined in header. E.g.:

```yaml
taxonomies:
faq: ["Android"]
faq: ["app"]
```

Zola collects all such taxonomies:

| File | Taxonomy key | Taxonomy value |
| -------------------- | ------------ | -------------- |
| android-lags.md | `faq` | `Android` |
| android-logs.md | `faq` | `Android` |
| general-team.md | `faq` | `General` |
| general-bugreport.md | `faq` | `General` |
| ios-versions.md | `faq` | `iOS` |
| map-longtap.md | `faq` | `Map` |
| ... | ... | ... |
| File | Taxonomy key | Taxonomy value |
|-----------------------------------------| ------------ |----------------|
| map/can-find-position/index.md | `faq` | `map` |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| map/can-find-position/index.md | `faq` | `map` |
| map/can-not-find-position/index.md | `faq` | `map` |

Copy link
Member

Choose a reason for hiding this comment

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

Should it be capitalized? e.g. Map, App?

Copy link
Sponsor Contributor Author

Choose a reason for hiding this comment

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

Renamed faq/map/can-find-position to faq/map/can-not-find-position
Updated "Taxonomy value" column

| map/search-cannot-find-a-place/index.md | `faq` | `map` |
| editing/map-errors/index.md | `faq` | `editing` |
| app/crash/index.md | `faq` | `app` |
| text-to-speech-android-tts/index.md | `faq` | `tts` |
| ... | ... | ... |

After that Zola gets all values for `faq` taxonomy: `[General, Android, iOS, Map, ...]`. And generates pages:
After that Zola gets all values for `faq` taxonomy: `[app, map, editing, tts, ...]`. And generates pages:

- For key `/faq/` with the list of values (see `templates/faq/list.html`)
- For each value `/faq/general`, `/faq/android`, etc. with the list of questions (see `templates/faq/single.html`)
- For each value `/faq/app`, `/faq/map`, etc. with the list of questions (see `templates/faq/single.html`)
Copy link
Member

Choose a reason for hiding this comment

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

Does it make sense to mention that for other languages taxonomies should be translated for better SEO?

Copy link
Sponsor Contributor Author

Choose a reason for hiding this comment

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

Added translated taxonomies samples: /es/faq/aplicacion/ and /de/faq/karte/


If you want to add new question then create .md file with header:

```yaml
title: A full question that is the title of the page
description: More detailed info with necessary keywords for better SEO
slug: the-url-of-the-page-that-can-be-localized-for-better-seo

taxonomies:
faq: ["General"]
faq: ["bookmarks"]
extra:
order: 40
```
Expand All @@ -91,13 +90,16 @@ taxonomies = [
]
[languages.XX.translations]
faq-menu-title = "{Translation of 'F.A.Q.' to a new language}"
faq_section_app = "App"
Copy link
Member

Choose a reason for hiding this comment

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

Is it still needed?

Copy link
Sponsor Contributor Author

Choose a reason for hiding this comment

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

Removed.

faq_section_bookmarks = "Bookmarks and Tracks"
faq_section_editing = "Map Editing"
faq_section_map = "Map"
faq_section_tts = "Voice Directions"
```

**Limitation**: List of taxonomies at `/faq/` page is always alphabetical. So 'Android' is always the first, 'Bookmarks' is the second, 'General' is the third and so on.

**Limitation**: Questions at any F.A.Q. sub-page are sorted by file name. An `extra.order` variable in .md content files is used for sorting articles.
**Limitation**: F.A.Q. categories are sorted alphabetically: "app", "bookmarks", "editing", "map", "tts".
strump marked this conversation as resolved.
Show resolved Hide resolved

**Limitation**: Each F.A.Q. sub-page has only a name. No description, no icon. Only name 'Android', or 'iOS', or 'Routing', etc.
**Limitation**: Each F.A.Q. category has only a name. No description, no icon. Only name 'App', or 'Bookmarks and Tracks', or 'Map Editing', etc.

## Contribution

Expand Down
5 changes: 5 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,11 @@ language = "Gallego"
language-word = "Idioma"
name = "Nome"
token = "Token"
[languages.pt]
taxonomies = [
{name = "faq", feed = false},
{name = "news", feed = true},
]
[languages.pt.translations]
address = "Endereço"
back = "Voltar às notícias"
Expand Down
10 changes: 10 additions & 0 deletions content/faq/_index.de.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Häufige Fragen und Antworten
description: In dieser FAQ findest du Antworten auf viele Fragen zur Organic Maps App, zu unseren Mitarbeitern und zu unserem Projekt
extra:
menu_title: F.A.Q.
---

### This page is replaced with taxonomy "faq" from templates/faq/list.html template

This file is needed for top_menu.html and bottom_menu.html templates to show F.A.Q.
2 changes: 1 addition & 1 deletion content/faq/_index.es.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Preguntas frecuentes de la aplicación Organic Maps
description: Preguntas frecuentes de la aplicación Organic Maps
description: Estas FAQ responden a muchas preguntas sobre la aplicación Organic Maps, nuestros colaboradores y nuestro proyecto
extra:
menu_title: Preguntas Frecuentes
---
Expand Down
10 changes: 10 additions & 0 deletions content/faq/_index.fr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Foire aux questions
description: Cette FAQ répond à de nombreuses questions sur l'application Organic Maps, nos contributeurs et notre projet.
extra:
menu_title: F.A.Q.
---

### This page is replaced with taxonomy "faq" from templates/faq/list.html template

This file is needed for top_menu.html and bottom_menu.html templates to show F.A.Q.
2 changes: 1 addition & 1 deletion content/faq/_index.it.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Domande frequenti
description: "Questa sezione contiene le risposte a molte domande sull'applicazione Organic Maps, sui nostri collaboratori e sul nostro progetto"
description: Questa sezione contiene le risposte a molte domande sull'applicazione Organic Maps, sui nostri collaboratori e sul nostro progetto
extra:
menu_title: Domande frequenti
---
Expand Down
10 changes: 10 additions & 0 deletions content/faq/_index.pl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Pytania i odpowiedzi
description: Ten FAQ zawiera odpowiedzi na wiele pytań dotyczących aplikacji Organic Maps, naszych współpracowników i naszego projektu
extra:
menu_title: Pomoc
---

### This page is replaced with taxonomy "faq" from templates/faq/list.html template

This file is needed for top_menu.html and bottom_menu.html templates to show F.A.Q.
10 changes: 10 additions & 0 deletions content/faq/_index.pt-BR.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Perguntas frequentes
description: Este FAQ contém respostas para muitas perguntas sobre o aplicativo Organic Maps, nossos colaboradores e nosso projeto
extra:
menu_title: Perguntas frequentes
---

### This page is replaced with taxonomy "faq" from templates/faq/list.html template

This file is needed for top_menu.html and bottom_menu.html templates to show F.A.Q.
10 changes: 10 additions & 0 deletions content/faq/_index.pt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Perguntas frequentes
description: Esta FAQ contém respostas a muitas perguntas sobre a aplicação Organic Maps, os nossos colaboradores e o nosso projeto
extra:
menu_title: Perguntas frequentes
---

### This page is replaced with taxonomy "faq" from templates/faq/list.html template

This file is needed for top_menu.html and bottom_menu.html templates to show F.A.Q.
2 changes: 1 addition & 1 deletion content/faq/_index.ru.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Справка и часто задаваемые вопросы
description: Ответы на вопросы о приложении Organic Maps и о нашем проекте
description: В этом разделе есть ответы на многие вопросы о приложении Organic Maps
extra:
menu_title: Справка
---
Expand Down
10 changes: 10 additions & 0 deletions content/faq/_index.tr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Sıkça Sorulan Sorular
description: Bu SSS, Organic Maps uygulaması, katkıda bulunanlarımız ve projemiz hakkında birçok sorunun yanıtını içermektedir
extra:
menu_title: SSS
---

### This page is replaced with taxonomy "faq" from templates/faq/list.html template

This file is needed for top_menu.html and bottom_menu.html templates to show F.A.Q.
10 changes: 10 additions & 0 deletions content/faq/_index.uk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Довідка та часті питання
description: Відповіді на поширені запитання стосовно застосунка Organic Maps
extra:
menu_title: Довідка
---

### This page is replaced with taxonomy "faq" from templates/faq/list.html template

This file is needed for top_menu.html and bottom_menu.html templates to show F.A.Q.
10 changes: 10 additions & 0 deletions content/faq/_index.zh-Hans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 问题和解答
description: 本常见问题回答了有关有机地图应用程序、我们的贡献者和我们项目的许多问题
extra:
menu_title: 问题和解答
---

### This page is replaced with taxonomy "faq" from templates/faq/list.html template

This file is needed for top_menu.html and bottom_menu.html templates to show F.A.Q.
21 changes: 21 additions & 0 deletions content/faq/app/crash/index.de.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Was kann ich tun, wenn die App sich aufhängt oder wenn sie abstürzt?
description: ""
updated: "2024-06-12"

taxonomies:
faq: ["App"]

extra:
order: 30
---

Es ist wahrscheinlich unser Fehler und wir werden ihn gerne im nächsten Update beheben.

Android: Wenn Sie Ihre Karten auf einer SD-Karte speichern, ist die wahrscheinlichste Ursache eine fehlerhafte SD-Karte. Sie können Ihre SD-Karte formatieren oder besser durch eine neue ersetzen. Wenn Sie die App selbst auf die SD-Karte verschoben haben, verschieben Sie sie bitte zurück in den internen (Geräte-) Speicher.

Wenn das Problem weiterhin besteht, [kontaktieren Sie uns bitte](mailto:[email protected]) und geben Sie uns:

* kurze Beschreibung des Problems
* Organic Maps Version
* Gerätemodell und Betriebssystemversion (Android oder iOS).
21 changes: 21 additions & 0 deletions content/faq/app/crash/index.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Qué hago si la aplicación se detiene o se bloquea?
description: ""
updated: "2024-06-12"

taxonomies:
faq: ["Aplicación"]

extra:
order: 30
---

Probablemente sea nuestro error y estaremos encantados de solucionarlo en la próxima actualización.

Android: Si almacenas los mapas en una tarjeta SD, lo más probable es que el error se deba a un fallo de la tarjeta. Puedes formatear la tarjeta SD o, mejor aún, cambiarla por otra nueva. Si has movido la app a la tarjeta SD, muévela al almacenamiento interno (de tu dispositivo).

Si el problema persiste [ponte en contacto con nosotros](mailto:[email protected]) y especifica por favor:

* la descripción corta del problema
* la version de Organic Maps
* el modelo de dispositivo y la versión de OS (Android o iOS).
21 changes: 21 additions & 0 deletions content/faq/app/crash/index.fr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Pourquoi l'application s'arrête ou crash?
description: ""
updated: "2024-06-12"

taxonomies:
faq: ["Application"]

extra:
order: 30
---

C'est probablement notre bug, et nous serons heureux de le corriger dans la prochaine mise à jour.

Android: Si vous stockez les cartes sur carte SD, vous pouvez la formater, c'est la cause la plus courante. Le formatage ou le remplacement résouds le plus souvent le problème.

Si le problème subsiste, merci de nous [contacter](mailto:[email protected]) et envoyer nous:

* un rapport d'erreur et une description du problème
* la version de Organic Maps
* Le modèle de l'appareil et la version du système d'exploitation (Android ou iOS).
23 changes: 23 additions & 0 deletions content/faq/app/crash/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: What can I do if the app has stopped/crashed?
description: What actions to take if the application crashes. How to report critical bugs to developers
updated: "2024-06-20"

taxonomies:
faq: ["App"]

extra:
order: 30
---

On Android, if you store your maps on an SD card, the most likely cause is a faulty SD card. You can:
1. Delete all downloaded maps and re-download them again to the SD card (may not work again).
2. Delete all downloaded maps, select Internal device storage, and re-download maps.
3. Format SD card and re-download maps.
4. Buy a new SD card (recommended)

If the app still crashes, please check [our GitHub](https://github.com/organicmaps/organicmaps/issues/) for similar issues, and [contact us](mailto:[email protected]) and provide the following:

* A detailed description of the issue and steps to reproduce it
* Organic Maps version
* Device model and OS version (Android or iOS)
21 changes: 21 additions & 0 deletions content/faq/app/crash/index.pl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Co mogę zrobić, jeśli aplikacja nie odpowiada/uległa awarii?
description: ""
updated: "2024-06-12"

taxonomies:
faq: ["Aplikacja"]

extra:
order: 30
---

Bu muhtemelen bizim hatamız ve bir sonraki güncellemede bunu düzeltmekten mutluluk duyacağız.

Android'de, haritalarınızı bir SD kartta saklarsanız, bunun en olası nedeni hatalı bir SD karttır. SD kartınızı biçimlendirebilir veya daha iyisi yenisiyle değiştirebilirsiniz. Uygulamayı SD karta taşıdıysanız, lütfen tekrar dahili (cihaz) depolama alanına taşıyın.

Sorun devam ederse, lütfen [bizimle iletişime geçin](mailto:[email protected]) ve şunları ekleyin:

* sorunun kısa açıklaması
* Organic Maps sürümü
* cihaz modeli ve İşletim Sistemi sürümü (Android veya iOS).
21 changes: 21 additions & 0 deletions content/faq/app/crash/index.pt-BR.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: O que posso fazer se o aplicativo parar (travar)?
description: ""
updated: "2024-06-12"

taxonomies:
faq: ["Aplicativa"]

extra:
order: 30
---

É provavelmente o nosso bug e ficaremos felizes em corrigi-lo na próxima atualização.

Android: se você armazenar seus mapas em um cartão SD, a causa mais provável é um cartão SD defeituoso. Você pode formatar seu cartão SD ou, melhor ainda, substituí-lo por um novo. Se você moveu o aplicativo para o cartão SD, mova-o de volta para o armazenamento interno (dispositivo).

Se o problema persistir, entre em [contato](mailto:[email protected]) conosco e forneça as seguintes informações:

* descrição do problema e etapas para recriá-lo
* Versão do Organic Maps
* modelo de dispositivo e versão do sistema operacional (Android ou iOS).
21 changes: 21 additions & 0 deletions content/faq/app/crash/index.pt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: O que fazer se a aplicação parar de funcionar (bloquear)?
description: ""
updated: "2024-06-12"

taxonomies:
faq: ["Aplicativa"]

extra:
order: 30
---

É provavelmente um erro inesperado e ficaremos contentes em corrigi-lo na próxima atualização.

Android: se armazena os mapas num cartão SD, a causa mais provável é ser um cartão SD defeituoso. Pode tentar formatar o cartão SD ou melhor ainda, substituí-lo por um novo. Se moveu a aplicação para o cartão SD, mova-o novamente no sentido inverso para o armazenamento interno (dispositivo).

Se mesmo assim o problema persistir, por favor [contacte-nos](mailto:[email protected]) e forneça as seguintes informações:

* descrição do problema e etapas para o recriar
* Versão do Organic Maps
* modelo do dispositivo e versão do sistema operativo (Android ou iOS).
21 changes: 21 additions & 0 deletions content/faq/app/crash/index.ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Что делать, если приложение перестало работать (остановлено)?
description: ""
updated: "2024-06-12"

taxonomies:
faq: ["Общие"]

extra:
order: 30
---

Это, скорее всего, баг в нашем коде, и мы будем рады исправить его в следующем обновлении.

На Android чаще всего эта проблема связана с плохой SD-картой. Если вы храните загруженные карты стран на SD-карте, попробуйте отформатировать ее, а лучше замените на новую. Если вы переместили само приложение на SD карту, пожалуйста, верните его назад в память устройства.

Если ошибка осталась, пожалуйста, [сообщите нам](mailto:[email protected]) о проблеме и уточните следующую информацию:

* краткое описание проблемы
* версия Organic Maps
* модель устройства и версия ОС (Android или iOS).
21 changes: 21 additions & 0 deletions content/faq/app/crash/index.tr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Uygulama durdurulursa/çökerse ne yapabilirim?
description: ""
updated: "2024-06-12"

taxonomies:
faq: ["Başvuru"]

extra:
order: 30
---

Bu muhtemelen bizim hatamız ve bir sonraki güncellemede bunu düzeltmekten mutluluk duyacağız.

Android'de, haritalarınızı bir SD kartta saklarsanız, bunun en olası nedeni hatalı bir SD karttır. SD kartınızı biçimlendirebilir veya daha iyisi yenisiyle değiştirebilirsiniz. Uygulamayı SD karta taşıdıysanız, lütfen tekrar dahili (cihaz) depolama alanına taşıyın.

Sorun devam ederse, lütfen [bizimle iletişime geçin](mailto:[email protected]) ve şunları ekleyin:

* sorunun kısa açıklaması
* Organic Maps sürümü
* cihaz modeli ve İşletim Sistemi sürümü (Android veya iOS).
Loading