Dienst:Homepage

Dokumentation zur Homepage

• URL: https://kbu.freifunk.net

Q: Wie ändere ich was?

• Änderungen auf gitlab einstellen (https://git.kbu.freifunk.net/ff-kbu/website),
  • Gitlab hat einen Web-Editor, über den Dateien bearbeitet werden können
  • Best-practice: Einzelnen Fork / Branch für jede Änderung erstellen
  • Achtung: Änderungen auf dem master-branch werden sofort live gestellt.
  • Alternativ checkout & Aufsetzen der Entwicklungsumgebung
• Ändern und testen (gitlab-ci durchlaufen lassen)
• Merge-Request mit den Änderungen erstellen

Technik

• Jekyll als Offline / Blogging System. Details: http://jekyllrb.com/

Blogposts

• Werden in Markdown geschrieben [1]
• Aus semantischen Gründen stehen nur die Überschrifen h1-h3, respektive # - ### in markdown zur Verfügung, beim Rendern werden diese verarbeitet
• Mittels <!--break--> kann ein Beitrag Einleitung und restlichen Text unterteilt werden.

Dabei sollte die Einleitung auf der Homepage nur ein oder zwei Absätze lang sein, der Rest ist dann auf der folgeseite zu lesen. Das bitte in der Zukunft beachten.

Workflow

• Änderungsvorschläge werden als Pull-Request gegen das github-Repo erstellt (https://git.kbu.freifunk.net/ff-kbu/website - Branch: master)
• Nach dem 4-Augen Prinzip wird der Pull-Request merged -- Kommentare, Fragen werden dort hinterlegt
• Existiert eine Änderung, so wird die Homepage über gitlab-ci deployed (https://git.kbu.freifunk.net/ff-kbu/website/pipelines)

Einrichten der Entwicklungsumgebung

Debian Stable / Wheezy

mkdir /verzeichnis/zur/website/
cd /verzeichnis/zur/website/

Notwendige Jekyll Komponenten installieren:

apt-get install ruby1.9.1 jekyll bundler git imagemagick
git clone https://git.kbu.freifunk.net/ff-kbu/website.git
bundle install

OSX

Getestet unter OS 10.6.8

mkdir /verzeichnis/zur/website/
cd /verzeichnis/zur/website/

Notwendige Jekyll Komponenten installieren, vorraussetzung ist Macports:

sudo port install ruby1.9 gem1.9 ImageMagick git-core Jekyll
gem1.9 install bundler
git clone https://git.kbu.freifunk.net/ff-kbu/website.git
bundle install

How to Jekyll

Soweit so gut, jetzt können wir:

bundle exec jekyll build 	// die Seite bauen
bundle exec jekyll -w	        // uns Änderungen anzeigen lassen
bundle exec jekyll serve -w	// Einen lokalen Server starten auf port 4000 (http://0.0.0.0:4000) auf dem wir eine Vorschau 
                                // der Seite betrachten können. 

Git Repo

Aktuellen Source der Page clonen

git clone https://git.kbu.freifunk.net/ff-kbu/website.git

Wer einen Account auf github hat, kann so von der Shell auf ein neues Repo erstellen:

touch README.md
git init
git add README.md
git commit -m "first commit"
git remote add origin https://git.kbu.freifunk.net/username/repo-name.git
git push -u origin master