Skip to content

Commit

Permalink
doc: inform about dependency on base installation
Browse files Browse the repository at this point in the history
That should make the documentation clearer if external sites link to the
documentation of a specific script.
  • Loading branch information
eworm-de committed May 3, 2021
1 parent e0e53b8 commit 64ff7fc
Show file tree
Hide file tree
Showing 31 changed files with 93 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/accesslist-duplicates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/bridge-port.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/capsman-download-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/capsman-rolling-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/certificate-renew-issued.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/check-certificates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/check-health.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/check-lte-firmware-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/check-routeros-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/cloud-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/collect-wireless-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/daily-psk.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/dhcp-lease-comment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/dhcp-to-dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/email-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/gps-track.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/hotspot-to-wpa.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/ipv6-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/lease-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/log-forward.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/mode-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/netwatch-notify.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/ospf-to-leds.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/packages-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/ppp-on-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/rotate-ntp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/sms-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/sms-forward.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/update-gre-address.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/update-tunnelbroker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
3 changes: 3 additions & 0 deletions doc/upload-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down

0 comments on commit 64ff7fc

Please sign in to comment.