website/README.md
Sergiy Kozyr bb813de21b
FAQ updates from main repo (#242)
* Added F.A.Q. question "Some places are missing on the map or have wrong names" from https://github.com/organicmaps/organicmaps/blob/master/data/faq.html

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Added F.A.Q. question "The app can't find my position on the map" from https://github.com/organicmaps/organicmaps/blob/master/data/faq.html

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Modified taxonomy from "Map Editing" to "Map"

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Added F.A.Q. question "I can't download (update) maps" from https://github.com/organicmaps/organicmaps/blob/master/data/faq.html

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Moved 2 FAQ questions to "map" subfolder

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Added F.A.Q. question "Search cannot find a place on the map" from https://github.com/organicmaps/organicmaps/blob/master/data/faq.html

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Renamed language from "zh" to "zh-Hans".
Added Ukrainian FAQ index.
Fixed missing FAQ translation errors.

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Explicit is better than implicit. Missing FAQ translation should raise an error. Added translation placeholders `{translate me}`

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Added debug page `/faq/translation_status` with the table of all FAQ pages with translations.

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Added F.A.Q. question "What can I do if the app has stopped/crashed?" from https://github.com/organicmaps/organicmaps/blob/master/data/faq.html

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Added F.A.Q. question "How to share (export) bookmarks?" from https://github.com/organicmaps/organicmaps/blob/master/data/faq.html

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Added F.A.Q. question "How to import bookmarks?" from https://github.com/organicmaps/organicmaps/blob/master/data/faq.html

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Small updates to content/faq/translation_status.md

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Changed order for "How to import bookmarks?" question

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Changed order for "The app can't find my position on the map" and "Search cannot find a place on the map" questions

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Translated FAQ categories into Russian

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Translated FAQ categories into Ukrainian

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Translated FAQ categories into Ukrainian and Espanol

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Showing updated date at translation_status.html page.
Showing "Edit this page on GitHub" link on the bottom of FAQ pages

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Fixed github edit link

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Inserted last updated date to new FAQ pages.
Updated /faq/translation_status page

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Updated English questions according to PR suggestions.

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Updated question "How to import bookmarks and tracks in KML, KMZ, or GPX format?"

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Translated "Frequently Asked Questions" and "F.A.Q." to supported languages using strings.txt from main repo

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Added "description" property to FAQ pages in English

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Updated FAQ description with DeepL translation

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Moved FAQ sections into config.toml translations.

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Updated README.md according to latest changes.

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Removed extra spaces. Fixed cases

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Implemented FAQ status page without JavaScript

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Revert "Moved FAQ sections into config.toml translations."

This reverts commit 5d1ecb1e8318a08b13242dd54024d585d9db5b4d.

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Fixed taxonomies names

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* Apply suggestions from code review.
Renamed `faq/map/can-find-position` to `faq/map/can-not-find-position`.
Added `KMB` to the list of supported formats.
Updated button title 'Import Bookmarks and Tracks' according to strings.txt from main repo.
Updated README.md

Signed-off-by: S. Kozyr <s.trump@gmail.com>

* [faq] Removed Android mention from import

Signed-off-by: Alexander Borsuk <me@alex.bio>

* Translated Edit on Github

Signed-off-by: Alexander Borsuk <me@alex.bio>

* Minor styling for Edit on GitHub button

Signed-off-by: Alexander Borsuk <me@alex.bio>

---------

Signed-off-by: S. Kozyr <s.trump@gmail.com>
Signed-off-by: Alexander Borsuk <me@alex.bio>
Co-authored-by: Alexander Borsuk <me@alex.bio>
2024-07-09 14:31:52 +02:00

3.6 KiB

Organic Maps Website

This static website is built with Zola and Cloudflare Pages.

Main Website

Development

Download the latest zola (version 0.17.2 at the time of writing) for your operating system and set up the necessary path variable.

Run zola serve for a local preview or zola build to generate static site in the public folder.

Run npm i && npm run format when you want to pretty-format the Markdown and SCSS files.

Upgrade npm dependencies with npm run upgrade, make sure that you have installed npm-check-updates package.

Deployment

Every PR deploys a preview version of the site at unique url.

Every merge into the master branch deploys changes into the production at https://organicmaps.app

Updating News

Run npm run news to automatically download news from our Telegram channel, then create a git commit and push it.

An example of a news post that is related to app updates/releases:

title: "OpenStreetMap login was fixed in Google Play"
date: 2024-03-18T17:45:35+00:00
slug: "openstreetmap-login-was-fixed-in-google-play"
taxonomies:
  news: ["Releases"]

For external links and press releases use this taxonomy:

taxonomies:
  news: ["Press"]

Taxonomy and F.A.Q. architecture

Each MD page in /faq/ has one or more taxonomy defined in header. E.g.:

taxonomies:
  faq: ["app"]

Zola collects all such taxonomies:

File Taxonomy key Taxonomy value
map/can-find-position/index.md faq Map
map/search-cannot-find-a-place/index.md faq Map
editing/map-errors/index.md faq Map Editing
app/crash/index.md faq App
text-to-speech-android-tts/index.md faq Voice Directions
... ... ...

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/app, /faq/map, etc. (including translated /es/faq/aplicacion, /de/faq/karte/) with the list of questions (see templates/faq/single.html)

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

title: A full question that is the title of the page
description: More detailed info with necessary keywords for better SEO

taxonomies:
  faq: ["Bookmarks and tracks"]
extra:
  order: 40

Zola will add your question to specific F.A.Q. sub-page.

If you need to translate the FAQ to a new language please add next lines to config.toml:

[languages.XX]
taxonomies = [
  {name = "faq", feed = false},
]
[languages.XX.translations]
faq-menu-title = "{Translation of 'F.A.Q.' to a new language}"

Limitation: F.A.Q. categories (taxonomies) are sorted alphabetically: "app", "bookmarks", "editing", "map", "tts".

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

Any good ideas and help with web site improvement are appreciated. And it's always better to discuss any improvement before implementing it to sync with our vision and plans.

Translations

Please help us with translating this web-site in your language. See TRANSLATIONS.md file for detailed instructions.