{"id":48662551,"url":"https://github.com/software-challenge/docs","last_synced_at":"2026-04-10T10:14:33.372Z","repository":{"id":25429858,"uuid":"28859391","full_name":"software-challenge/docs","owner":"software-challenge","description":"Dokumentation für Teilnehmer der Software-Challenge Germany","archived":false,"fork":false,"pushed_at":"2026-04-07T11:34:13.000Z","size":88721,"stargazers_count":5,"open_issues_count":8,"forks_count":8,"subscribers_count":9,"default_branch":"main","last_synced_at":"2026-04-07T13:26:09.651Z","etag":null,"topics":["asciidoc","documentation","software-challenge"],"latest_commit_sha":null,"homepage":"https://docs.software-challenge.de/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/software-challenge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2015-01-06T11:02:13.000Z","updated_at":"2026-04-07T11:33:53.000Z","dependencies_parsed_at":"2024-03-27T10:42:33.888Z","dependency_job_id":"37d0332c-0594-495d-b690-1d207651afc5","html_url":"https://github.com/software-challenge/docs","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/software-challenge/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/software-challenge%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/software-challenge%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/software-challenge%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/software-challenge%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/software-challenge","download_url":"https://codeload.github.com/software-challenge/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/software-challenge%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31637856,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T07:40:12.752Z","status":"ssl_error","status_checked_at":"2026-04-10T07:40:11.664Z","response_time":98,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asciidoc","documentation","software-challenge"],"created_at":"2026-04-10T10:14:32.793Z","updated_at":"2026-04-10T10:14:33.363Z","avatar_url":"https://github.com/software-challenge.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Software-Challenge Endbenutzer-Dokumentation \n\nIn diesem Repository befindet sich die Endbenutzer-Dokumentation \nfür die [Software-Challenge](https://software-challenge.de).\nZielgruppe sind Schülerinnen, Schüler und Lehrkräfte,\ndie an der Software-Challenge teilnehmen.\n\nZiel dieser Dokumentation ist es,\nalle Informationen über die Software-Challenge an einer Stelle zu bündeln.\nHier können sich Lehrkräfte und Kursleiter über den Zweck der Software-Challenge informieren.\nFür die teilnehmenden Teams ist hier alles dokumentiert,\nwas für die Teilnahme am Wettbewerb benötigt wird.\n\n## Beitragen\n\nWir freuen uns über sämtliche Verbesserungsvorschläge.  \nDie Dokumentation kann direkt hier \nauf [GitHub](https://github.com/software-challenge/docs/blob/main/hyperbook/book) editiert werden,\neinzige Voraussetzung ist eine kostenlose Registrierung bei GitHub.\nNach der Anmeldung ein Dokument auswählen \nund dann auf den Stift oben rechts klicken.\nDie relevanten Dokumente finden sich im Verzeichnis [hyperbook/book](./hyperbook/book).\nDamit wird von GitHub automatisch ein Fork \nund ein dazugehöriges Pull Request erstellt.  \nAlternativ auch gerne per E-Mail an \u003ctech@software-challenge.de\u003e \noder als Nachricht im [Discord](https://discord.gg/jhyF7EU).\n\n### Konventionen fürs Editieren\n- Zeilenumbrüche jeweils am Ende von Sätzen bzw. semantischen Grenzen,\n  orientiert an [Semantic Line Breaks](https://sembr.org).\n  Dabei kann https://waldyrious.net/semantic-linebreaker/ als Hilfe dienen.\n- Datei- und Verzeichnisnamen sollten nur die Zeichen `a` bis `z` \n  sowie Bindestriche (`-`) enthalten.\n- Sprache für Dateinamen, Verzeichnisnamen sowie Inhalt ist Deutsch.\n  Sprache für Attribute und sonstige Interna ist Englisch.\n\n### Hinweise für Beiträge\nCommitnachrichten wird der Dateipfad der geänderten Datei oder des Ordners vorangestellt, \nggf. gekürzt um überflüssige Elemente (z.B. `blokus/` statt `spiele/blokus/`).\nUm bei den Branches die Übersicht zu behalten,\nsollten diese ebenfalls nach der Konvention benannt werden.\nDarüber hinaus guten Stil beachten: https://cbea.ms/git-commit/\n\nAnsonsten folgend wir soweit sinnvoll der [Kull Konvention](https://kull.jfischer.org).\n\n## Hyperbook\nDie Dokumentation wird mit der Software [Hyperbook](https://hyperbook.openpatch.org/) bereitgestellt.\nDie einzelnen Seiten sind im Ordner `hyperbook` im Markdown-Syntax hinterlegt \nund können mit einem entsprechenden Editor bearbeitet werden.\nIm `hyperbook`-Ordner sollte auch jeder folgende Befehl ausgeführt werden.\n\n### Node.js und NPM\nUm Hyperbook zu HTML zu konvertieren, \nmuss die Laufzeitumgebung [Node.js](https://nodejs.org/en/) installiert sein.\nDies geht unter Debian-basierten Distributionen mit `sudo apt install nodejs npm`.\nUnter Arch: `sudo pacman -S npm`\n\n### Live-Preview\nEine Vorschau lokaler Änderungen kann direkt mit dem Befehl `npx hyperbook dev` \naus dem Ordner `hyperbook` generiert werden.\nDies startet einen Entwicklungsserver,\ndessen Ergebnisse unter `http://localhost:8080/` einsehbar sind.\n\n### Build\nUm das Hyperbook zu veröffentlichen,\ngeneriert `npx hyperbook build` die Website in `./hyperbook/.hyperbook/out`.\n\n## Veröffentlichung\n\nDie [öffentliche Seite](https://docs.software-challenge.de) \nwird automatisch bei jedem push in den `main`-Branch von GitHub aktualisiert.\nDies geschieht durch einen [GitHub Actions Workflow](.github/workflows/auto-publish.yml).\nDer Workflow speichert die generierten Seiten im `live` branch des Repositories,\nwelcher nach Benachrichtigung durch einen Webhook von [caddy](./Caddyfile) gepullt wird.\n\nBei Änderungen am Caddyfile oder dem Docker image \nmuss [push-production.sh](./bin/push-production.sh) \nmit dem GITHUB_SECRET des Webhooks ausgeführt werden\n(bei credential-abfrage beliebigen Text eingeben).\nDer Docker container lässt sich auch lokal mit [test-production.sh](./bin/test-production.sh) testen,\nwobei der Caddy Webserver auf port 80 via [localhost](http://localhost) erreichbar wird.\n\nTODO: Eigenes Caddyfile mit \"debug\" und Dockerfile mit lokalem build für testing\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftware-challenge%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoftware-challenge%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftware-challenge%2Fdocs/lists"}