switch2osm

Цей репозиторій містить матеріали для osm-ua.github.io/switch2osm/. Вони є результатом перекладу українською матеріалів основного, англомовного репозиторію. (Див. також README.origin.md)

Ознайомтесь з питаннями які ми намагались висвітлити.

Вимоги до змісту

• Висвітлення від базових понять до технічних покрокових настанов.

  Зосередитись на технічному боці справи (налаштування сервера рендерінгу) легко, але більшість користувачів більше зацікавлені в тому, як перейти на своєму дуже маленькому веб-сайті від Google на OSM, тому більше дбайте про те, як кількома компонентами замінити монолітний API Google Maps та як налаштувати веб-сторінку, щоб використовувати безкоштовні послуги отримання тайлів.

• Не зациклюйтесь на якомусь одному рішенні чи постачальнику послуг.

• Не вимагайте якихось особливих зовнішніх служб, окрім самого OpenStreetMap.

  Ми не рекламуємо щось, що може призвести до залежності від послуг якогось одного постачальника, тож настанови мають бути корисними без привʼязки до сторонніх сервісів. Добре надати приклад (це може бути tile.osm.org) у якого є багато альтернатив, на відміну від якогось безальтернативного рішення, або чогось такого, що складно відтворити.

  Винятки:

  • planet.openstreetmap.org, для даних OSM
  • openstreetmapdata.com, для берегових ліній та інших готових даних
  • Natural Earth та інші широко відомі публічні джерела даних

Технічні вимоги

• Використовуйте покрокові пояснення, замість однорядкових сценаріїв shell.

  Один сценарій, який виконує довгу серію завдань, може бути корисним, але не надає розуміння того, що відбувається. Як тільки хтось хоче змінити найменший аспект, виявиться, що особа не здобула ніяких знань. Ці сценарії також, як правило, легко псуються.

• Не пропонуйте неякісні варіанти, навіть у демонстраціях.

  Люди будуть намагатись повторити короткі демо. Не використовуйте погані практики, які навіть працюють, лиш тому що це просте демо.

• Намагайтесь уникати збирати щось з сирців.

  Збирання чогось із сирців привносить лиш додаткову складність на допомагаючи зрозуміти що відбувається.

• Уникайте бінарних вставок, які важко відтворити.

  Інструкції повинні адаптуватися до інших ОС або дистрибутивів. Це означає, що користувач повинен мати можливість будувати з джерела, якщо це потрібно. Системи пакування ОС та PPA відповідають цьому.

• Використовуйте інструкції, які можна легко переносити з платформи на платформу та адаптувати під майбутні зміни.

  Це важко зробити, але інструкції повинні бути придатні для роботи в майбутньому, наскільки це можливо, щодо майбутніх дистрибутивах, чи, наприклад, використовувати результати роботи конфігураційних сценаріїв, а не жорстко прописані шляхи.

• Використовуйте засоби розповсюдження програмного забезпечення, що використовуються операційними системами, якщо це можливо.

  Використовуйте apt чи homebrew. Також за допомогою PPA, має бути можливо встановити все програмне забезпечення подібним чином.

Співробітництво

Вебсторінка побудовані за допомогою GitHub Pages. Для перегляду ваших змін виконайте наступні команди:

• bundle install --path .vendor/bundle
• bundle exec jekyll serve

та відкрийте у вашому оглядачі посилання http://127.0.0.1:4000/