From 64ff7fcf65ade97535afaa84531697f997239b30 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Mon, 3 May 2021 15:07:50 +0200 Subject: [PATCH] doc: inform about dependency on base installation That should make the documentation clearer if external sites link to the documentation of a specific script. --- doc/accesslist-duplicates.md | 3 +++ doc/bridge-port.md | 3 +++ doc/capsman-download-packages.md | 3 +++ doc/capsman-rolling-upgrade.md | 3 +++ doc/certificate-renew-issued.md | 3 +++ doc/check-certificates.md | 3 +++ doc/check-health.md | 3 +++ doc/check-lte-firmware-upgrade.md | 3 +++ doc/check-routeros-update.md | 3 +++ doc/cloud-backup.md | 3 +++ doc/collect-wireless-mac.md | 3 +++ doc/daily-psk.md | 3 +++ doc/dhcp-lease-comment.md | 3 +++ doc/dhcp-to-dns.md | 3 +++ doc/email-backup.md | 3 +++ doc/gps-track.md | 3 +++ doc/hotspot-to-wpa.md | 3 +++ doc/ipv6-update.md | 3 +++ doc/lease-script.md | 3 +++ doc/log-forward.md | 3 +++ doc/mode-button.md | 3 +++ doc/netwatch-notify.md | 3 +++ doc/ospf-to-leds.md | 3 +++ doc/packages-update.md | 3 +++ doc/ppp-on-up.md | 3 +++ doc/rotate-ntp.md | 3 +++ doc/sms-action.md | 3 +++ doc/sms-forward.md | 3 +++ doc/update-gre-address.md | 3 +++ doc/update-tunnelbroker.md | 3 +++ doc/upload-backup.md | 3 +++ 31 files changed, 93 insertions(+) diff --git a/doc/accesslist-duplicates.md b/doc/accesslist-duplicates.md index 2189322..0f08284 100644 --- a/doc/accesslist-duplicates.md +++ b/doc/accesslist-duplicates.md @@ -3,6 +3,9 @@ Find and remove access list duplicates [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/bridge-port.md b/doc/bridge-port.md index 8cbe15b..d5435b4 100644 --- a/doc/bridge-port.md +++ b/doc/bridge-port.md @@ -3,6 +3,9 @@ Manage ports in bridge [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/capsman-download-packages.md b/doc/capsman-download-packages.md index 8516ff4..cdbd72b 100644 --- a/doc/capsman-download-packages.md +++ b/doc/capsman-download-packages.md @@ -3,6 +3,9 @@ Download packages for CAP upgrade from CAPsMAN [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/capsman-rolling-upgrade.md b/doc/capsman-rolling-upgrade.md index 04952e2..92eafa6 100644 --- a/doc/capsman-rolling-upgrade.md +++ b/doc/capsman-rolling-upgrade.md @@ -3,6 +3,9 @@ Run rolling CAP upgrades from CAPsMAN [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/certificate-renew-issued.md b/doc/certificate-renew-issued.md index e460ce1..63d6408 100644 --- a/doc/certificate-renew-issued.md +++ b/doc/certificate-renew-issued.md @@ -3,6 +3,9 @@ Renew locally issued certificates [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/check-certificates.md b/doc/check-certificates.md index 318805d..5b1e3b2 100644 --- a/doc/check-certificates.md +++ b/doc/check-certificates.md @@ -3,6 +3,9 @@ Renew certificates and notify on expiration [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/check-health.md b/doc/check-health.md index 37f8e34..f1b9d91 100644 --- a/doc/check-health.md +++ b/doc/check-health.md @@ -3,6 +3,9 @@ Notify about health state [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/check-lte-firmware-upgrade.md b/doc/check-lte-firmware-upgrade.md index c71dee5..a145da8 100644 --- a/doc/check-lte-firmware-upgrade.md +++ b/doc/check-lte-firmware-upgrade.md @@ -3,6 +3,9 @@ Notify on LTE firmware upgrade [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/check-routeros-update.md b/doc/check-routeros-update.md index bd25ab1..416ba98 100644 --- a/doc/check-routeros-update.md +++ b/doc/check-routeros-update.md @@ -3,6 +3,9 @@ Notify on RouterOS update [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/cloud-backup.md b/doc/cloud-backup.md index 1417242..60e71c9 100644 --- a/doc/cloud-backup.md +++ b/doc/cloud-backup.md @@ -3,6 +3,9 @@ Upload backup to Mikrotik cloud [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/collect-wireless-mac.md b/doc/collect-wireless-mac.md index 45489bf..4da06b9 100644 --- a/doc/collect-wireless-mac.md +++ b/doc/collect-wireless-mac.md @@ -3,6 +3,9 @@ Collect MAC addresses in wireless access list [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/daily-psk.md b/doc/daily-psk.md index d472269..ec55c85 100644 --- a/doc/daily-psk.md +++ b/doc/daily-psk.md @@ -3,6 +3,9 @@ Use wireless network with daily psk [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/dhcp-lease-comment.md b/doc/dhcp-lease-comment.md index caba7d6..0b8ceb2 100644 --- a/doc/dhcp-lease-comment.md +++ b/doc/dhcp-lease-comment.md @@ -3,6 +3,9 @@ Comment DHCP leases with info from access list [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/dhcp-to-dns.md b/doc/dhcp-to-dns.md index 699b6a5..22bf3bc 100644 --- a/doc/dhcp-to-dns.md +++ b/doc/dhcp-to-dns.md @@ -3,6 +3,9 @@ Create DNS records for DHCP leases [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/email-backup.md b/doc/email-backup.md index 7076691..85d50bd 100644 --- a/doc/email-backup.md +++ b/doc/email-backup.md @@ -3,6 +3,9 @@ Send backup via e-mail [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/gps-track.md b/doc/gps-track.md index cda7901..e4e553c 100644 --- a/doc/gps-track.md +++ b/doc/gps-track.md @@ -3,6 +3,9 @@ Send GPS position to server [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/hotspot-to-wpa.md b/doc/hotspot-to-wpa.md index fbb9640..108cfd5 100644 --- a/doc/hotspot-to-wpa.md +++ b/doc/hotspot-to-wpa.md @@ -3,6 +3,9 @@ Use WPA2 network with hotspot credentials [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/ipv6-update.md b/doc/ipv6-update.md index f736433..994ea23 100644 --- a/doc/ipv6-update.md +++ b/doc/ipv6-update.md @@ -3,6 +3,9 @@ Update configuration on IPv6 prefix change [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/lease-script.md b/doc/lease-script.md index 3c774f1..6391c40 100644 --- a/doc/lease-script.md +++ b/doc/lease-script.md @@ -3,6 +3,9 @@ Run other scripts on DHCP lease [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/log-forward.md b/doc/log-forward.md index afb695e..0993b52 100644 --- a/doc/log-forward.md +++ b/doc/log-forward.md @@ -3,6 +3,9 @@ Forward log messages via notification [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/mode-button.md b/doc/mode-button.md index 8d037e5..3cea720 100644 --- a/doc/mode-button.md +++ b/doc/mode-button.md @@ -3,6 +3,9 @@ Mode button with multiple presses [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/netwatch-notify.md b/doc/netwatch-notify.md index 11371ff..627070a 100644 --- a/doc/netwatch-notify.md +++ b/doc/netwatch-notify.md @@ -3,6 +3,9 @@ Notify on host up and down [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/ospf-to-leds.md b/doc/ospf-to-leds.md index 72fab6b..908fb56 100644 --- a/doc/ospf-to-leds.md +++ b/doc/ospf-to-leds.md @@ -3,6 +3,9 @@ Visualize OSPF state via LEDs [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/packages-update.md b/doc/packages-update.md index 882ce80..cc4a29b 100644 --- a/doc/packages-update.md +++ b/doc/packages-update.md @@ -3,6 +3,9 @@ Manage system update [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/ppp-on-up.md b/doc/ppp-on-up.md index 432a640..7514f82 100644 --- a/doc/ppp-on-up.md +++ b/doc/ppp-on-up.md @@ -3,6 +3,9 @@ Run scripts on ppp connection [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/rotate-ntp.md b/doc/rotate-ntp.md index eb04f5c..c151db2 100644 --- a/doc/rotate-ntp.md +++ b/doc/rotate-ntp.md @@ -3,6 +3,9 @@ Rotate NTP servers [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/sms-action.md b/doc/sms-action.md index df9e14f..e36d384 100644 --- a/doc/sms-action.md +++ b/doc/sms-action.md @@ -3,6 +3,9 @@ Act on received SMS [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/sms-forward.md b/doc/sms-forward.md index 27c3847..d603daa 100644 --- a/doc/sms-forward.md +++ b/doc/sms-forward.md @@ -3,6 +3,9 @@ Forward received SMS [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/update-gre-address.md b/doc/update-gre-address.md index 870759e..e45e17a 100644 --- a/doc/update-gre-address.md +++ b/doc/update-gre-address.md @@ -3,6 +3,9 @@ Update GRE configuration with dynamic addresses [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/update-tunnelbroker.md b/doc/update-tunnelbroker.md index 3641588..caff9ff 100644 --- a/doc/update-tunnelbroker.md +++ b/doc/update-tunnelbroker.md @@ -3,6 +3,9 @@ Update tunnelbroker configuration [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description ----------- diff --git a/doc/upload-backup.md b/doc/upload-backup.md index e6ba9e2..4b656e4 100644 --- a/doc/upload-backup.md +++ b/doc/upload-backup.md @@ -3,6 +3,9 @@ Upload backup to server [◀ Go back to main README](../README.md) +🛈 This script can not be used on its own but requires the base installation. +See [main README](../README.md) for details. + Description -----------