farsetlabs.github.io

Farset Labs Hauptwebsite

Eine Jekyll- und Bootstrap -basierte Informationswebsite für Farset Labs, einen Hackerspace und eine Wohltätigkeitsorganisation in Belfast, Nordirland.

QuickStart

Installieren Sie die für Jekyll benötigten Voraussetzungen. Dies beinhaltet eine aktuelle Version von Ruby (2.5 oder später). Wir empfehlen, die neueste stabile Version von Ruby zu verwenden, die mit Jekyll und Ihrer ausgewählten Plattform funktioniert. Sie können Ihre Version von Ruby durch Laufen überprüfen:

ruby --version

Wir haben vorgeschlagen, dass Sie RVM oder RBENV verwenden, um verschiedene Versionen von Ruby lokal zu verwalten.

Sobald Sie die Prequistes installiert haben, öffnen Sie das Projektverzeichnis und führen Sie aus:

gem install bundler
bundle install
bundle exec jekyll serve -w

Öffnen Sie http: // localhost: 4000 in einem Browser, um die Website anzuzeigen.

Bau mit Docker

Docker bietet reproduzierbare Umgebungen zur Unterstützung der Entwicklung. Um mit dieser Website mit Docker zu arbeiten, stellen Sie zuerst sicher, dass Docker auf Ihrem Computer installiert ist, und dann ausführen:

docker build -t farsetlabs-site . docker run -p 4000:4000 -v `pwd`:/app farsetlabs-site

Dadurch wird ein Container gestartet, die Website erstellt und dann auf Port 4000 serviert. Das Bearbeiten von Dateien auf Ihrem Computer führt dazu, dass der Container die Site wieder aufgebaut und die im Browser verfügbaren Änderungen zur Verfügung stellt (warten Sie auf die Bestätigungsnachricht des Builds).

Regenerating: 1 file(s) changed at 2019-06-13 09:33:17
                    index.html
                    ...done in 10.680932188 seconds.

Beitragen

Ihre Änderungen vornehmen

Alle Beiträge zur Website und in den Inhalt sollten über eine Filiale erfolgen. Sie sollten den Feature Branch Workflow befolgen, wenn Sie dazu beitragen.

Wir haben eine Hauptzweig, main , die die Live -Website repräsentiert. Laufende Verbesserungen an der Website, die noch nicht in Feature -Zweigen leben, entweder in diesem Repository oder in seinen Gabeln.

Bitte verzweigen Sie sich von der neuesten main für Ihre Änderungen.

Wenn Sie keinen Zugriff auf unser Repository haben, geben Sie uns bitte auf Github und senden Sie Ihre Filiale über eine Pull -Anfrage.

Wenn Sie kein Entwickler sind, sollten Sie Korrekturen und Inhaltsverbesserungen als Probleme erhöhen.

Sidebar -Links bearbeiten

Sidebar-Links sind aus _includes/sidebar-links.md enthalten. Um die Seitenleiste zu aktualisieren, bearbeiten Sie diese Datei einfach.

Ihre Änderungen einreichen

Sobald Sie Ihre Änderungen (entweder an unser Repo oder Ihre Gabel als Mitwirkender) überschritten haben, sollten Sie eine Pull -Anfrage öffnen. Unser Webteam wird es überprüfen. Bitte lassen Sie mindestens eine kurze Beschreibung der Änderungen und detailliert alle Änderungen an Layout oder der Funktionalität der Website.