Ce dépôt est le contenu du site web https://switch2osm.org construit en utilisant Material for MkDocs. Voyez les questions sur lesquelles travailler. Couvre...

Dépôt créer le : 17/12/2015

Forks: 70 Watcher: 0 66

Github: https://github.com/switch2osm/switch2osm

Ajouter à une sélection :

Connectez-vous pour gérer vos sélections.

switch2osm

Ce dépôt est le contenu pour https://switch2osm.org site web construit en utilisant Matériel pour MkDocs.

Voyez les questions sur lesquelles travailler.

Principes de contenu

Couvre des principes de premier ordre à des méthodes techniques.
Il est facile de se concentrer sur les guides techniques (mise en place d'un serveur de rendu), mais la plupart des utilisateurs sont plus intéressés par la façon de changer leur site Web très petit de Google, donc se soucient plus de la façon dont le monolithique Google Maps "API" est remplacé par plusieurs composants, et comment configurer leur page Web pour utiliser un service de carrelage gratuit.
Évite le verrouillage avec des fournisseurs ou des services spécifiques
Ne nécessite pas de services externes spécifiques, à part OpenStreetMap elle-même
Nous ne faisons la promotion de rien qui peut entraîner le verrouillage à un fournisseur spécifique, donc les guides doivent être utilisables sans compter sur un tiers. Il est normal d'utiliser quelque chose comme exemple (par exemple carle.osm.org) où il y a beaucoup d'alternatives, mais pas s'il y a peu d'alternatives ou si le service utilisé ne peut pas être reproduit.
Les exceptions sont
- planet.openstreetmap.org, pour les données OSM elle-même
- osmdata.openstreetmap.de, pour les côtes et autres données prétraitées
- Terre naturelle et autres sources de données publiques bien utilisées

Besoins techniques du contenu

Utilise plusieurs étapes pour construire la compréhension, plutôt qu'un script shell
Un script unique qui complète une longue série de tâches peut être utile, mais ne permet pas de comprendre ce qui est fait. Dès que quelqu'un veut changer le moindre aspect, il trouve qu'il n'a acquis aucune connaissance. Ces scripts ont également tendance à être fragiles.
Ne présente pas de mauvaises pratiques, même dans une démo
Les gens vont copier/coller des démos courtes. N'utilisez pas de mauvaises pratiques qui fonctionnent juste parce que la démo est simple.
Évite de construire à partir de la source
Bâtir de source ajoute des complications importantes tout en aidant peu à la compréhension.
Évite les blobs binaires qui ne peuvent pas être reproduits
Les instructions devraient pouvoir être adaptées à d'autres OS ou distributions. Cela signifie que l'utilisateur devrait être en mesure de construire à partir de la source si nécessaire. Les systèmes d'emballage OS et les AAE répondent à cette exigence.
Utilise des instructions portatives compatibles avec l'avant
Cela est difficile à faire, mais des instructions devraient être élaborées pour travailler à l'avenir et, dans la mesure du possible, sur les distributions futures. Par exemple, utiliser la sortie des programmes de configuration plutôt que les chemins de codage dur.
Utilise des méthodes de distribution OS pour les logiciels si possible
Utilisation apt ou homebrew ou similaire.
Évitez d'utiliser des AAE dans la mesure du possible.
Les AAE peuvent être utiles pour regrouper des versions plus différentes de logiciels ensemble, au-delà de ce qui est distribué par le système d'exploitation de base, mais ils ont tendance à ne pas être supportés pour toujours, et ne sont pas automatiquement testés pour la compatibilité avec les nouvelles versions d'exploitation. De plus, le support OS de base des composants utilisés ici est beaucoup mieux qu'il ne l'était.

Contribuer

La page Web est construite en utilisant mkdocs. Pour compiler vos modifications, exécutez

git clone [email protected]:switch2osm/switch2osm.git
cd switch2osm
python3 -m venv venv
source ./venv/bin/activate
pip install -r requirements.txt
mkdocs serve

Ouvrir http://127.0.0.1:8080/ dans votre navigateur.

Exécuter le site Web localement avec Docker

Si vous préférez utiliser Docker pour exécuter le site localement, suivez ces étapes:

Assurez-vous que Docker soit installé sur votre système. Sinon, vous pouvez le télécharger depuis Site officiel de Docker.
Naviguez dans le répertoire racine du dépôt de votre terminal.
Exécutez la commande suivante pour construire et démarrer le site Web :
```
docker compose up --build
```
Ouvrir http://127.0.0.1:8080/ dans votre navigateur pour consulter le site.

Affichage des changements

Pour voir les modifications apportées au site Web, vous devrez arrêter le conteneur en cours d'exécution et relancer la commande ci-dessus.

Traduction

Pour ajouter une traduction dans votre langue, suivez les étapes suivantes :

Commencez par éditer mkdocs.yml fichier, qui peut être trouvé à la racine du dépôt. Pour voir un exemple de la façon de le faire, consultez comment la traduction ukrainienne est ajoutée. Une fois terminé, votre langue sera incluse dans le commutateur de langue, et tous les éléments de menu et les instructions seront affichés dans votre langue.
Ensuite, vous pouvez commencer à traduire le texte des articles. Voici comment :
a. Dupliquer en dossier et remplacer son nom par votre code de langue. Maintenir les noms des fichiers inchangés.
b. Traduire les valeurs des clés de la matière première dans chaque fichier Markdown dans votre dossier de langue.
c. Dans chaque fichier Markdown, définissez le lang clé dans la matière première pour correspondre à votre code de langue, qui devrait être le même que le nom de votre dossier de langue.
d. Préserver le formatage Markdown tel quel; il n'est pas nécessaire de le modifier.
Si vous avez mkdocs serve script en cours d'exécution tout en effectuant des modifications, le contenu traduit sera automatiquement reflété dans le contenu affiché après l'enregistrement.

En suivant ces étapes, vous pouvez apporter des traductions au projet, le rendant accessible à un public plus large dans votre langue.