Pište interaktivní dokumentaci se šablonami a parametry

Řekněme, že chcete provést místní přesměrování portů přes SSH, ale nepamatujete si příkaz. Rychle vyhledáte na google a najdete něco takového:

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

Ale ve vašem případě SSH server neběží na standardním portu, takže musíte zadat vlastní port. Provedete další rychlé vyhledávání a sestavíte celý příkaz (v hlavě nebo v textovém editoru, který funguje jako vyrovnávací paměť):

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

Nyní máte obecný příklad a musíte nahradit klíčové části příkazu, aby fungoval. Takže musíte nahradit místní port, vzdálený port, vzdáleného uživatele, vzdálenou IP a SSH port.

O několik zkopírování a vložení později a zjistíte, že jste zapomněli, jak to funguje:local_port:ip:remote_port NEBO remote_port:ip:local_port ? Google vás znovu zachrání:

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

Právě jste strávili 10 minut shromažďováním nebo obnovováním cenných informací. Také jste strávili drahocenný čas úpravami nebo kopírováním a vkládáním částí příkazu, abyste si jej přizpůsobili.

ReactiveDoc vám může pomoci napsat dokumentaci se šablonami a parametry. Proč je to užitečné? Protože vám to ušetří pár minut, až budete chtít tento příkaz znovu použít.

Začněme základním příkazem jako šablonou:

Přidejte základní vysvětlení z https://linux.die.net/man/1/ssh a odkaz na tento vynikající zdroj

Poté přidejte číselný vstup a změňte hodnotu štítku na "Local Port", variableName na "local_port" a nastavte 8080 jako defaultValue takto:

V šabloně příkazu nahraďte 8080 výrazem {{local_port}}

Nyní přidejte textový vstup pro cílovou IP a poté nahraďte „localhost“ v šabloně řetězcem {{destination_ip}} proměnná:

Část každého příkazu můžete extrahovat jako parametr:

Exportujte tento dokument jako HTML stránku a až budete příště chtít přesměrovat SSH port, stačí jej otevřít v libovolném prohlížeči, nastavit parametry, kliknout na tlačítko 'kopírovat' a vložit jej do terminálu. Ušetřené 2 minuty!

Tento soubor HTML můžete také sdílet se svým týmem (k jeho spuštění nemusí nic instalovat – funguje v jakémkoli prohlížeči) nebo jej hostit na místním serveru jako statickou stránku.

Vyzkoušejte ReactiveDoc Now!