it-swarm.com.de

Wie kann ich eine Wiki-Seite auf GitHub anfordern?

Ich habe auf GitHub eine Wiki-Seite gesehen, die nicht zum Bearbeiten geöffnet ist. Dann habe ich das Projekt gegabelt, es auf "my end" bearbeitet und versucht, eine Pull-Anfrage zu machen. Es stellt sich heraus, dass das Wiki nicht im Projekt enthalten ist und es keine Möglichkeit gibt, Änderungen daran vorzunehmen.

Gibt es eine andere Möglichkeit als das Versenden per E-Mail, wenn ich in diesem Fall eine Änderung im Wiki vorschlagen möchte?

An diesem Punkt fand ich heraus, was scheint eine Alternative zu sein unter "Fragen mit ähnlichen Titeln", aber ich konnte die Pull-Anforderung noch nicht damit durchführen, und deshalb bin ich nicht sicher, ob Submodule eine gute sind Weg zu diesem Zweck. Ich sehe jetzt, dass ich es wahrscheinlich irgendwie verzweigen könnte ... Also ist das der richtige Weg?

130
cregox

GitHub nterstützt keine Pull-Anfragen für das Wiki-Repository , nur das Haupt-Repository (das ist ein bisschen schade, IMO, aber ich kann es verstehen).

Hier ist eine interessante Art und Weise, wie ein Projekt Community-Updates für sein Wiki verwaltet und dabei die Kontrolle über den Quellcode behält:

Mein vorgeschlagener Workflow lautet wie folgt:

  1. Erstelle manuell einen Fork des Taffy-Wikis in deinem Github-Account:
    • Erstellen Sie ein neues Repository in Ihrem Github-Konto. Nennen wir es "Taffy-Wiki".
    • Klonen Sie das Taffy-Wiki-Repo irgendwo auf Ihrem lokalen Computer: git clone [email protected]b.com:atuttle/Taffy.wiki.git
    • Entfernen Sie die Originalfernbedienung "Origin" und fügen Sie Ihr Github-Repo als neues "Origin" hinzu git remote rm Origin und git remote add Origin [email protected]:<YOUR_USERNAME>/Taffy-Wiki.git
  2. Nehmen Sie die vorgeschlagenen Änderungen vor Ort vor und übertragen Sie sie auf Ihr Github-Konto: git Push -u Origin master ('-u Origin Master' wird nur beim ersten Mal benötigt; danach einfach git Push)
  3. Senden Sie ein Ticket an den offiziellen Taffy Issue Tracker und fordern Sie mich auf, Ihre Änderungen zu überprüfen und zu übernehmen. Bitte fügen Sie einen Link zu Ihrem Repo bei und beschreiben Sie, was Sie geändert haben.
  4. Springe zu # 2

(Von Wie Sie zur Taffy-Dokumentation beitragen können.)

Wenn ich es wäre, würde ich ein Problem im Haupt-Repository erstellen (d. H. Das, das Sie gegabelt haben) und ein Update für das Wiki vorschlagen. Wenn Probleme nicht aktiviert sind, sind E-Mails die einzige andere Option, die mir in den Sinn kommt.

103
Calrion

Ich habe einen anderen Ansatz gewählt, nämlich genau den gleichen Inhalt in das Hauptrepo und das Wiki zu pushen. Dies wird nicht jedermanns Sache sein, aber Risk-First ist hauptsächlich ein Wiki mit ein paar Jekyll-Seiten im Hauptrepo.

Dies bedeutet, dass der Pull Request/Fork-Prozess einwandfrei funktioniert. Nach dem Zusammenführen einer Pull-Anfrage muss ich jedoch den zusätzlichen Schritt ausführen, in mein lokales Repo zu ziehen und dann sowohl in das Haupt-Repo als auch in das Wiki zu verschieben, das mit mehreren Origin-URLs problemlos unterstützt wird:

localhost:website robmoffat$ git remote show Origin
* remote Origin
  Fetch URL: [email protected]:risk-first/website.git
  Push  URL: [email protected]:risk-first/website.wiki.git
  Push  URL: [email protected]:risk-first/website.git
  HEAD branch: master

Um dies zu erreichen, habe ich die Commits aus beiden Repos folgendermaßen zusammengeführt:

Wie werden zwei Git-Repositorys zusammengeführt?

Und dann zu beiden Repos wie folgt pushen:

Git - Pushing Code auf zwei Fernbedienungen

Hoffe das hilft jemandem.

1
Rob Moffat

Wenn Sie ein einseitiges Dokument haben möchten (es gefällt mir besser), können Sie das README.MD und dort den Inhalt des Wikis einfügen.

Es wird nicht nur als Teil des normalen Repositorys nachverfolgt, sondern auch auf der Homepage angezeigt.

Sie können mit einer Kurzreferenz beginnen und dann eine ausführlichere Beschreibung/Anleitung aufrufen, sodass die regulären Benutzer zuerst die allgemeineren Informationen aufrufen.

0
Igor Stoppa

Sie können keine Pull-Anfrage stellen, aber Sie können ein Problem öffnen, einen Link zu Ihrer Wiki-Seite einfügen und sie in Ihrer Wiki-Seite zu ihrer Wiki-Seite zusammenführen lassen.

Zusamenfassend:

Sie müssen nur Ihr Wiki-Seiten-Repo klonen, (git clone YOUR_FORKED_REPO.wiki.git), zerdrücke alle deine Wiki-Commits zu einem großen Commit und wähle dann diesen großen Squash-Commit für ihr Repo aus. Dadurch werden alle Änderungen in Ihrem Wiki in das Wiki übernommen.

Vollständige Anweisungen:

(AUS Larry Bothas Github Gekopiert HIER: https://Gist.github.com/larrybotha/1065041 ):

---------- BEGINN DER KOPIERPASTE VON OBEN GITHUB Gist ------------

Wiki-Änderungen aus einem Gorked Github Repo zusammenführen

Dies ist von Roman Ivanov inspiriert (oder im Grunde genommen kopiert) von Wie Github-Wiki-Änderungen von einem Repository in ein anderes zusammengeführt werden und dient dazu, sicherzustellen, dass die Informationen auch dann erhalten bleiben, wenn etwas mit dem Originalartikel passiert sicher hier.

Terminologie

[~ # ~] orepo [~ # ~] : Original-Repo - das vom Eigentümer erstellte oder gepflegte Repo

[~ # ~] frepo [~ # ~] : das gespaltene Repo, dessen Wiki vermutlich aktualisiert wurde, noch nicht auf dem [~ # ~] orepo [~ # ~]

Mitmachen

Wenn Sie zum Wiki eines von Ihnen gespaltenen Repos beitragen möchten, gehen Sie wie folgt vor:

  • gabel das repo
  • klone nur das wiki auf deinen rechner: $ g clone [FREPO].wiki.git
  • nehmen Sie Änderungen an Ihrem lokalen Forked Wiki-Repo vor
  • Übertragen Sie Ihre Änderungen auf GitHub

Wenn Sie bereit sind, dem Autor mitzuteilen, dass Sie Änderungen vorgenommen haben, gehen Sie wie folgt vor:

  • öffne eine Ausgabe auf [~ # ~] orepo [~ # ~]
  • biete einen direkten Link zum Git-Repo deines Wikis, um das Zusammenführen zu vereinfachen: d. h. [ [~ # ~] frepo [~ # ~] ]. wiki.git

Änderungen zusammenführen

Als Besitzer von [~ # ~] orepo [~ # ~] haben Sie jetzt eine Nachricht erhalten, dass es Aktualisierungen für Ihr Wiki bei jemand anderem gibt [~ # ~] frepo [~ # ~] .

Wenn Wiki-Änderungen vom letzten [~ # ~] orepo [~ # ~] Wiki gespalten werden, können Sie Folgendes tun:

$ git clone [OREPO].wiki.git
$ cd [OREPO].wiki.git

# squashing all FREPO changes
$ git pull [FREPO].wiki.git master

$ git Push Origin master

Wenn [~ # ~] orepo [~ # ~] wiki vor where [~ # ~] frepo steht [~ # ~] ausgehend von:

$ git clone [OREPO].wiki.git
$ cd [OREPO].wiki.git
$ git fetch [FREPO] master:[FREPO-branch]
$ git checkout [FREPO-branch]

#checkout to last OREPO commit
$ git reset --hard [last-OREPO-commit-hash]

# do massive squash of all FREPO changes
$ git merge --squash [email protected]{1}
$ git commit -m "Wiki update from FREPO - [description]"
$ git checkout master

# cherry-pick newly squashed commit
$ git cherry-pick [OREPO-newly-squashed-commit]
$ git Push

---------- ENDE DER KOPIERPASTE AUS DEM OBEN GENANNTEN GITHUB ------------

0
Gabriel Staples