Nebenprojekt: Deutsche Bedienungsanleitungen für MIUI / Xiaomi Geräte

  • Vorneweg: Alle Frage zu diesem Thema bitte ausschließlich an mich bitti hier im Forum oder auf dem Chatserver !!!


    Grund der Projektenstehung: Anhaltender Mangel (bzw nichtvorhandensein) an/von deutschen Anleitungen für Xiaomi Geräte sowie dem MIUI System
    Projektgrundlage: Mkdocs



    Wer kann mitmachen: Alle die einen Github Account haben und bereit sind sich in die Markdown "Sprache" einzulesen (wird u.a. auf Github für README's genutzt)
    Kenntnisse von Jekyll sind von Vorteil (Wer Github Pages nutzt hat Sie schon)


    Ausführlich:


    Wer mithelfen will für das kommende MIUI8 sowie den bereits veröffentlichten Xiaomi Geräte deutsche Anleitungen zu schreiben, kann dies am ca mogen Mittag tun.
    Benötigt wird nur ein Github Account sowie Grundkenntnisse der Markdown "Sprache" .



    User die schon etwas mehr Kenntnisse mit Github haben können das unten verlinkte Repo auch clonen und die Änderungen mit einem Editor Ihrer Wahl machen (z.B. Atom) und anschließend einen Push Request erstellen.


    Bitte für jede größere Änderung einen eigenen Push Request erstellen.


    Preview:


    Live: https://docs.miui-germany.de/
    Source: https://github.com/MIUI-GER/docs-miui8


    Wer fragen hat kann sie via PM an mich , hier im Thread als Antwort oder im docs Kanal auf dem Chatserver (Google/Github oder Gitlab Account erforderlich zum Login) stellen.


    Technisches:
    Die einfache Änderung über ein Github Repo wird durch die vor Längerer Zeit durchgeführte Umstellung unseres Servers von Hiawatha auf Caddy ermöglicht. :
    1. Der Webserver überprüft alle 60min das Github Repo auf eine Änderung.
    2. Gabs eine Änderung, wird die Geänderte Datei heruntergeladen und der Jekyll Befehl zum generieren der HTML Version gestartet.
    3. Die generierten html Dateien werden vom mkdocs Prozess in den unter https://docs.miui-germany.de/ erreichbaren Ordner kopiert.


    Aufbau:


    /index.md -> Startseite
    /miui/Miuiversion/*.md -> Wird zu /miui(miuiversionsnummer)/* -> z. B. /miui8/*
    /geräte/Gerätename/*.md -> Wird zu /Gerätename/* -> z.B. /mi1/*


    Hinweise:
    Alle Dateien müssen die .md Endung besitzen.
    Änderung an den Dateien im _Layout oder _data Ordner nur nach vorheriger Absprache (betrifft vorwiegend die Einträge des Header Menüs sowie der Sidebars)
    Infos zu den Formatierungsmöglichkeiten des Jekyll Styles: http://idratherbewriting.com/documentation-theme-jekyll/

  • Kurz-Anleitung zum editieren /hinzufügen von Kategorien/Texte


    1. Vorraussetzung:
    - https://github.com/MIUI-GER/docs-miui8 geforkt -> Kann man online rechts oben mit Klick auf Fork machen.
    . Fortgeschritten: Den Fork via git clone auf den heimischen PC/MAC kopiert.
    -- HINWEIS: Alle Dokumentationsdateien bitte immer im docs Ordner ablegen/speichern!!! Anderswo abgelegte Dateien werden vom Server ignoriert.


    2. Editieren:
    - Die Datei die man ändern will auf der Github Seite öffnen
    -- Z.B. https://github.com/(Github Username)/docs-miui8/blob/master/docs/index.md
    - Mit Klick auf Edit den Editor aktivieren und die Änderung durchführen.
    -- Fortgeschritten: Die .md Datei in Editor eurer Wahl öffnen und die Änderung durchführen..


    3. Neuen Menüpunkt erstellen:
    - Auf der Github Seite im /docs Ordner von eurem Fork auf den Button "Create New File" klicken
    - Der Dateiname muss folgendes Format haben : Menüpunktname.md -> z.B. faq.md
    - Die Änderung durchführen.
    -- Fortgeschritten: Die .md Datei in Editor eurer Wahl anlegen und die Änderung durchführen.


    4. Änderung speichern/hochladen
    -- Auf github.com
    - Unter "Commit changes" im ersten Textfeld eine Kurzbeschriebung eurer Änderung eintragen
    - Im großen textfeld darunter könnt ihr eine Langversion eurer Änderung eintragen (optional)
    - Anschließend auf den grünen "Commit changes" Button klicken.
    - Anschließend wieder ins Hauptverzeichnis von eurem Fork gehen, Auf "New pull request" klicken und anschließend 2x auf den grünen "Create pull request" Button klicken.
    --Auf eurem PC
    -Ein Terminal/eine Konsole öffnen und ins Hauptverzeichnis eures geclonten Forks gehen und danach folgende Befehle eingeben (jeweils mit Enter bestätigen)
    - 'git add .'
    - 'git commit -m "Kurzversion eurer Änderung"'
    - 'git push'
    - Anschließend auf Github.com ins Hauptverzeichnis von eurem Fork gehen, Auf "New pull request" klicken und anschließend 2x auf den grünen "Create pull request" Button klicken.

Jetzt mitmachen!

Sie haben noch kein Benutzerkonto auf unserer Seite? Registrieren Sie sich kostenlos und nehmen Sie an unserer Community teil!