/hnm-nikola

Nikola Sourcen der Homepage der Hack & Make 2020

Primary LanguagePython

hnm-nikola Build Status

Nikola Sourcen der Homepage der Hack & Make 2020

Wie kann ich etwas ändern?

  • Ihr benötigt einen github-Account. Falls Ihr noch keinen habt, der ist schnell eingerichet.
  • Dann benötigt ihr Schreibrechte in der fablabnbg-Organization oder zumindest in diesem Repository hier. Dazu schickt einfach euren github-Benutzernamen an Ian. (Zum Beispiel, indem Ihr einfach hier ein neues "Issue" eröffnet).
  • Dann könnt Ihr direkt im Browser über das "Stift"-Icon die Seiten ändern.
    • Die Texte liegen alle in den Unterverzeichnissen "pages" und "posts".
    • Für reine Text-Änderungen ist das die einfachste Methode.
    • Das RST-Format lernt man am besten durch Anschauen und Nachmachen. Mehr erfährt man auf https://de.wikipedia.org/wiki/ReStructuredText
    • Die Änderungen sind in wenigen Minuten auf https://fablabnbg.github.io/hnm-nikola/ zur Vorschau, und nach Freigabe (durch Ian, Simon, oder Jürgen) dann auch auf hackmake.de

Wie kann ich lokal ändern oder neue Seiten hinzufügen?

  • Wenn Ihr Änderungen am Design vornehmen wollt oder Neuigkeiten oder Seiten hinzufügen wollt, installiert ihr am besten Nikola lokal.
  • Installationsanleitung unter Linux:
    1. python3 verwenden/ggf. installieren: sudo apt install python3-pip
    2. virtualenv installieren: pip install virtualenv -- bitte unbedingt darauf achten, dass ihr python3 verwendet. Ggf. dazu pip3 anstelle von pip eingeben.
    3. Erstellt ein neues leere Unterverzeichnis und wechselt dort hin. (Zum Beispiel mkdir nikola && cd nikola)
    4. Erstellt ein virtualenv in diesem Verzeichnis: virtualenv .
    5. Aktiviert das virtualenv: source bin/activate
    6. Installiert nikola: pip install nikola[extras]
    7. Holt Euch die Sourcen der Webseite: git clone https://github.com/fablabnbg/hnm-nikola.git
    8. Wechselt ins Unterverzeichnis: cd hnm-nikola
  • Ändern/neu erstellen (unter Linux):
    1. Wechselt in eurer nikola-virtualenv-Verzeichnis
    2. Aktiviert das virtualenv: source bin/activate
    3. Wechselt ins Unterverzeichnis: cd hnm-nikola
    4. Dort könnt ihr nun die diversen Dateien nach Euren Wünschen und mit einem Editor Eurer Wahl (vim, VS Code, kate, ...) anpassen
    5. Zum neuerstellen der Seiten: nikola build
    6. Zum lokalen Anschauen der Seiten: nikola serve -b
    7. Zum deployen der erstellten Webseite auf dem Testserver: nikola github_deploy
    8. Zum speichern der Änderungen an den Sourcen auf github:
      1. Ggf. Auflisten der geänderten Dateien mit git status
      2. Alle geänderten Dateien zum comitten vormerken: git add .
      3. Ggf. Anzeigen der Änderungen mit git diff
      4. Änderungen comitten: git commit -m "<Änderungsbeschreibung>"
      5. Den Commit auch auf dem remote-Server (=github) speichern: git push

Verbesserungsvorschläge/Änderungswünsche

Verbesserungsvorschläge oder Änderungswünsche meldet Ihr am besten einfach hier als "New Issue" an.

Technische Details

Nikola Config

  • liegt in conf.py
  • Theme ist das Standard-Theme für Webseiten: "bootstrap4" und bist jetzt unverändert.
  • Anpassung des Design liegt in files/assets/css/custom.css

Deployment (lokal):

  • Zur Zeit erfolgt das Deployment in Richtung github-pages
  • TODO: Deployment auf eigenen Server
    • Wird sinnvollerweise über rsync mittels ssh-key erfolgen.

Details zum Deployment

  • Erfolgt über github Actions
  • TODO (Travis CI kommt dabei nicht mehr zum Einsatz)