Schreiben Sie interaktive Dokumentation mit Vorlagen und Parametern

Angenommen, Sie möchten eine lokale Portweiterleitung über SSH durchführen, erinnern sich aber nicht an den Befehl. Du machst eine schnelle Suche bei Google und findest so etwas:

ssh -L 8080:localhost:80 [email protected]

Aber in Ihrem Fall läuft der SSH-Server nicht auf dem Standardport, also müssen Sie den benutzerdefinierten Port angeben. Sie führen eine weitere Schnellsuche durch und stellen den vollständigen Befehl zusammen (in Ihrem Kopf oder in einem Texteditor, der als Puffer fungiert):

ssh -L 8080:localhost:80 [email protected] -p 1234

Jetzt haben Sie ein generisches Beispiel und müssen die wichtigsten Teile im Befehl ersetzen, damit es funktioniert. Sie müssen also den lokalen Port, den Remote-Port, den Remote-Benutzer, die Remote-IP und den SSH-Port ersetzen.

Ein paar Copy-Paste später stellen Sie fest, dass Sie vergessen haben, wie es funktioniert:local_port:ip:remote_port ODER remote_port:ip:local_port ? Google rettet Sie wieder:

ssh -L LOCAL_PORT:DESTINATION:DESTINATION_PORT [USER@]SSH_SERVER

Sie haben gerade 10 Minuten damit verbracht, einige wertvolle Informationen zu sammeln oder aufzufrischen. Sie haben auch wertvolle Zeit damit verbracht, Teile des Befehls zu bearbeiten oder zu kopieren und einzufügen, um ihn anzupassen.

ReactiveDoc kann Ihnen helfen, Dokumentation mit Vorlagen und Parametern zu schreiben. Warum ist das nützlich? Weil es Ihnen ein paar Minuten erspart, wenn Sie diesen Befehl das nächste Mal wiederverwenden möchten.

Beginnen wir mit dem Grundbefehl als Vorlage:

Fügen Sie einige grundlegende Erklärungen von https://linux.die.net/man/1/ssh und einen Link zu dieser hervorragenden Ressource

hinzu

Fügen Sie dann eine Zahleneingabe hinzu und ändern Sie den Etikettenwert in „Local Port“, den Variablennamen in „local_port“ und legen Sie 8080 als Standardwert fest, wie folgt:

Ersetzen Sie in der Befehlsvorlage 8080 durch {{local_port}}

Fügen Sie nun eine Texteingabe für die Ziel-IP hinzu und ersetzen Sie dann „localhost“ in der Vorlage durch den {{destination_ip}} Variable:

Sie können den Teil jedes Befehls als Parameter extrahieren:

Exportieren Sie dieses Dokument als HTML-Seite und wenn Sie das nächste Mal eine SSH-Portweiterleitung durchführen möchten, öffnen Sie es einfach mit einem beliebigen Browser, stellen Sie die Parameter ein, klicken Sie auf die Schaltfläche „Kopieren“ und fügen Sie es in ein Terminal ein. 2 Minuten gespart!

Sie können diese HTML-Datei auch mit Ihrem Team teilen (sie müssen nichts installieren, um sie auszuführen – sie funktioniert in jedem Browser) oder sie auf einem lokalen Server als statische Seite hosten.

Probieren Sie ReactiveDoc jetzt aus!