Solltest du Hilfe brauchen oder eine Frage haben, mach gerne ein Issue auf oder frag im OKFDE-Slack Channel #codeforde-website nach.
Um zur Website beizutragen brauchst du einen GitHub-Account. Solltest du den noch nicht haben, dann kannst du ihn hier anlegen
Öffne das codefor.de Repository in deinem Browser.
Um sicherzustellen, dass dein Inhalt auch gefunden wird, benötigen wir ein paar Metadaten, aber wir lassen dich damit nicht allein. Unter archetypes findest du Templates für alle möglichen Inhalte
wähle aus, was du erstellen willst und klickt anschließend auf RAW
Der Metadaten Bereich ist umschlossen von ---, kopier dir den Inhalt, den brauchen wir gleich!
Gehe zurück auf start.. nicht über los
Navigiere zu codefor.de/content/ und wählt den Inhalt deiner Wahl aus (im Beispiel wird es projekte sein)
Danach klicktst du auf Add file > create new file
und gibst deinem Inhalt einen Namen nach dem Schema Jahr-Monat-Tag-Tite.md (YYYY-MM-DD-####.md)
Jetzt brauchen wir die Metadaten aus dem Template wieder, einfach einfügen. Für Projekte sieht das dann z.B. so aus:
---
layout: project #do not change
lab: [berlin] #change into your city/lab
imgname: #add file to assets/projects/your city
title: Titel #project title
status: Laufend
draft: true #set to 'false'
links:
- url: #add url
name: Website
- url: #add url
name: Code
---
<!--short project description here-->benutze bitte NICHT den Schnipsel hier, die benötigten Metadaten können sich immer mal ändern und werden hier nicht nachgepflegt!
Alles über den --- Strichen, sind Metadaten.
Alles was hinter einem # bis zum Ende der Zeile steht, ist ein Kommentar den du löschen kannst, der dir beim Ausfüllen helfen soll.
Alles was nach dem zweiten --- steht, ist der Inhalt der Seite.
Der Inhalt wird in Markdown (commonmark) geschrieben, hier ist eine ausführliche Referenz und hier eine Kurzreferenz
Wenn du mit deinem Beitrag zufrieden bist, dann klicke unten auf Propose new file.
Jetzt passieren ein paar Dinge bei GitHub im Hintergrund. Es wird ein Fork von okfde/codefor.de in deinem Account erstellt. Auf dem Fork wird ein branch erstellt. Wenn du nichts mit git zu tun haben willst, kannst du die Terminologie aber einfach Ignorieren und zum nächsten Schritt springen.
Bei Blogposts brauchen wir unbedingt ein Bild, bei Labs und Projekten nicht. Wenn du keine Bilder in deinem Artikel hast, springt einfach weiter zu 5 Der Pull Request
Im Moment ist es etwas kompliziert, aber wir bekommen das hin. Der Schritt wird sich auch in naher Zukunft ändern.
Als Erstes musst du den in Schritt 3. erstellen Branch auswählen
Alle Bilder werden im Moment im Ordner static gelagert also unter static/projects oder static/blog oder static/labs. Such dir den passenden Pfad zu deinem Artikel und klick auf upload files
Anschließend auf commit changes
Fast geschafft, nur noch der Pull Request.
Github zeigt dir auf der Übersichtsseite direkt was zu tun ist! Klicke einfach auf create Pull Request
Danach wirst du gebeten einen Titel und eine kurze Beschreibung einzugeben. Das hilft dem Website-Team einfach zu entscheiden oder Feedback zu geben. Wenn du fertig bist, kannst du hier @okfde/codeforde-devs erwähnen und dafür sorgen, dass sich jemand darum kümmert, dass der Artikel veröffentlicht wird!
Sobald du auf Create Request klickst, öffnet sich eine neue Seite und es laufen ein paar automatisierte Tests und es wird eine Vorschau der gesamten Seite erzeugt
Wenn in der markierten Zeile vorn ein grüner Haken ist, kannst du auf Details klicken und du landest auf der Vorschauseite!
Das war's!! Sobald der Inhalt freigegeben wird, ist er auf codefor.de sichtbar
Voraussetzungen
- github account join github
- lokale installation von git quick start git
- lokale installation von hugo quick start hugo Achtung, wir benötigen
Hugo Extended
- Das codeforde repository clonen
git clone https://github.com/okfde/codefor.de - einen neuen branch anlegen
git checkout -b NEUER_BRANCH - einen neuen Artikel anlegen (zb blogpost)
hugo new blog/JJJJ-MM-TT-einzigartigername.md(inhalt siehe 3 Euer Inhalt) - Mindestens ein Bild im Verzeichnis
static/blogeinfügen (bei Labs und Projekten nicht nötig) und den Dateinamen in den Metadaten im Blogpost unterimgnameeinfügen. - Mit
hugo -Dpassiert ein wenig hugo magic und impublicOrdnerblog/JJJJ-MM-TT-einzigartigername.htmlist dein Artikel wie er später auf der Website aussehen wird. - Dateien zu git hinzufügen
git add blog/JJJJ-MM-TT-einzigartigername.md blog/tollesbild.jpg - commiten
git commit -m "Hier die Commit-Nachricht, z.B. add Blogeintrag zu xyz" - pushen
git push - Pull Request stellen wie in 5 Der Pull Request