diff --git a/source/appendix/contribute/edit-on-github.rst b/source/appendix/contribute/edit-on-github.rst index 26828dd8e..4c72a5007 100755 --- a/source/appendix/contribute/edit-on-github.rst +++ b/source/appendix/contribute/edit-on-github.rst @@ -3,37 +3,49 @@ Dokumentation in GitHub ändern ------------------------------ -Wenn Du einen Fehler (Rechtschreibfehler, kleine inhaltliche Fehler, etc.) in der Dokumentation gefunden hast, klicke einfach auf den ``Edit on Github`` Link am rechten oberen Rand jeder Dokumentationsseite. +Um Fehler etc. in der Dokumentation in GitHub ändern zu können, musst Du Dich zuerst in GitHub anmelden und das linuxmuster-docs repository auswählen. -.. figure:: media/01_edit-on-github_button.png +Wenn Du einen Fehler (Rechtschreibfehler, kleine inhaltliche Fehler, etc.) in der Dokumentation gefunden hast, klicke auf die gewünschte Quelldatei, in der Du dies ändern möchtest. + +Du siehst dann nachstehende Menüleiste: + +.. figure:: media/01_select_source-file.png :align: center - :alt: Edit on Github + :alt: select source file + + Ausgewählte Quelldatei zur Änderung -Damit wirst Du auf github.com geleitet. Mit einem Klick auf den Stift -(siehe Bild) kannst Du das aktuelle Kapitel bearbeiten. Dafür müsst -du Dich bei GitHub anmelden. Wenn Du noch kein Konto bei GitHub -hast, kannst Du `hier eines anlegen `_ -oder oben rechts auf "Sign up" klicken. +Klicke dann auf den Pfeil rechts neben dem Stift-Symbol. Es erscheint dann folgendes Untermenü: -.. figure:: media/02_edit-on-github_open-a-chapter.png +.. figure:: media/02_edit-in-place.png :align: center - :alt: Edit not signed in + :scale: 80% + :alt: edit in place + + Editiere die ausgewählte Datei -Die Dokumentation ist in der Auszeichnungssprache "rST" geschrieben. `Hier `_ findest Du einen guten Überblick über die am häufigsten verwendeten Elemente. +Klicke auf ``Edit in place``. Es wird auf GitHub die Datei in einem Online-Editor geöffnet. Diese kann wie in nachstehender Abbildung aussehen. -.. figure:: media/03_edit-on-github_edit-signed-in.png +.. figure:: media/03_edit-in-place-editor-opened.png :align: center - :alt: Edit signed in + :alt: edit with online editor in github + + Fügre die Änderungen online ein -Im Beispiel wurde der Rechtschreibfehler und die Länge der zur Überschrift gehörenden Unterschreichung geändert. +Die Dokumentation ist in der Auszeichnungssprache "rST" geschrieben. `Hier `_ findest Du einen guten Überblick über die am häufigsten verwendeten Elemente. -Nachdem Du alle Änderungen vorgenommen hast, gib unten einen Titel und einen Kommentar ein. Die Änderungen können nun mit einem Klick auf "Propose file changes" eingereicht werden. +Nachdem Du alle Änderungen vorgenommen hast, klickst Du oben rechts auf ``Commit changes...``. Es öffnet sich ein neues Fenster. -.. figure:: media/04_edit-on-github_propose-changes.png +.. figure:: media/04_add_extended_description.png :align: center - :alt: propose changes + :scale: 80% + :alt: add extended description + + Füge Deinen Änderungen eine Beschreibung hinzu + +Füge hier unter der Überschrift ``Extended description`` die Beschreibung für die von Dir vorgenommenen Änderungen ein und klicke unten rechts auf ``Commit changes``. -Dein Änderungsvorschlag wird dann vom Dokumentationsteam geprüft und gegebenenfalls übernommen. Sekunden später erscheint die Änderung dann auch hier in der offiziellen Dokumentation. +Dein Änderungsvorschlag wird dann vom Dokumentationsteam geprüft und gegebenenfalls übernommen. Danach erscheint die Änderung dann auch hier in der offiziellen Dokumentation. .. hint:: @@ -43,7 +55,10 @@ Sollest Du bereits Schreibrechte am Repositorium haben und bist Dir sicher, dass .. figure:: media/05_edit-on-github_commit-changes.png :align: center + :scale: 80% :alt: commit changes directly + + Füge die Änderungen direkt in den Zweig hinzu. Größere Änderungen an der Dokumentation sind immer über Pull-Requests zu erstellen. Dafür ist es nützlich, lokal eine Kopie (fork) vorzuhalten und Änderungen lokal zu testen, das im :doc:`entsprechenden Kapitel ` erklärt wird. diff --git a/source/appendix/contribute/media/01_select_source-file.png b/source/appendix/contribute/media/01_select_source-file.png new file mode 100644 index 000000000..0029a17ea Binary files /dev/null and b/source/appendix/contribute/media/01_select_source-file.png differ diff --git a/source/appendix/contribute/media/02_edit-in-place.png b/source/appendix/contribute/media/02_edit-in-place.png new file mode 100644 index 000000000..fbf457b7b Binary files /dev/null and b/source/appendix/contribute/media/02_edit-in-place.png differ diff --git a/source/appendix/contribute/media/02_edit-on-github_open-a-chapter.png b/source/appendix/contribute/media/02_edit-on-github_open-a-chapter.png deleted file mode 100755 index e89566d17..000000000 Binary files a/source/appendix/contribute/media/02_edit-on-github_open-a-chapter.png and /dev/null differ diff --git a/source/appendix/contribute/media/03_edit-in-place-editor-opened.png b/source/appendix/contribute/media/03_edit-in-place-editor-opened.png new file mode 100644 index 000000000..71da3db1a Binary files /dev/null and b/source/appendix/contribute/media/03_edit-in-place-editor-opened.png differ diff --git a/source/appendix/contribute/media/03_edit-on-github_edit-signed-in.png b/source/appendix/contribute/media/03_edit-on-github_edit-signed-in.png deleted file mode 100755 index 1366a2911..000000000 Binary files a/source/appendix/contribute/media/03_edit-on-github_edit-signed-in.png and /dev/null differ diff --git a/source/appendix/contribute/media/04_add_extended_description.png b/source/appendix/contribute/media/04_add_extended_description.png new file mode 100644 index 000000000..2e28c4488 Binary files /dev/null and b/source/appendix/contribute/media/04_add_extended_description.png differ diff --git a/source/appendix/contribute/media/04_edit-on-github_propose-changes.png b/source/appendix/contribute/media/04_edit-on-github_propose-changes.png deleted file mode 100755 index f242d6027..000000000 Binary files a/source/appendix/contribute/media/04_edit-on-github_propose-changes.png and /dev/null differ diff --git a/source/appendix/contribute/media/05_edit-on-github_commit-changes.png b/source/appendix/contribute/media/05_edit-on-github_commit-changes.png old mode 100755 new mode 100644 index f35ed70e3..93f68e261 Binary files a/source/appendix/contribute/media/05_edit-on-github_commit-changes.png and b/source/appendix/contribute/media/05_edit-on-github_commit-changes.png differ