From 5e52b3191803e1dabd1d47ed7e51bf2531aa8526 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Sat, 21 Nov 2020 12:19:18 -0700 Subject: [PATCH] Better icons --- docs/admin/updating.md | 2 +- docs/art/themes.md | 2 +- docs/configuration/config-files.md | 6 ++++-- docs/configuration/event-scheduler.md | 6 +++--- docs/configuration/security.md | 2 +- docs/filebase/first-file-area.md | 4 ++-- docs/installation/docker.md | 4 ++-- docs/installation/install-script.md | 2 +- docs/installation/manual.md | 2 +- docs/messageareas/configuring-a-message-area.md | 2 +- docs/messageareas/ftn.md | 2 +- 11 files changed, 18 insertions(+), 16 deletions(-) diff --git a/docs/admin/updating.md b/docs/admin/updating.md index 3cf93768..59ab3111 100644 --- a/docs/admin/updating.md +++ b/docs/admin/updating.md @@ -25,7 +25,7 @@ npm install # or 'yarn' :information_source: Visual diff tools such as [DiffMerge](https://www.sourcegear.com/diffmerge/downloads.php) (free, works on all major platforms) can be very helpful for the tasks outlined above! -:information_source: It is recommended to tail the logs and poke around a bit after an update. +:bulb: It is recommended to [monitor logs](/docs/troubleshooting/monitoring-logs.md) and poke around a bit after an update! diff --git a/docs/art/themes.md b/docs/art/themes.md index 9bf1419a..ec3e3684 100644 --- a/docs/art/themes.md +++ b/docs/art/themes.md @@ -11,7 +11,7 @@ Themes live in `art/themes/`. Each theme (and thus it's *theme ID*) is a directo ## Art For information on art files, see [General Art Information](general.md). TL;DR: In general, to theme a piece of art, create a version of it in your themes directory. -:information_source: Remember that by default, the system will allow for randomly selecting art (in one of the directories mentioned above) by numbering it: `FOO1.ANS`, `FOO2.ANS`, etc.! +:note: Remember that by default, the system will allow for randomly selecting art (in one of the directories mentioned above) by numbering it: `FOO1.ANS`, `FOO2.ANS`, etc.! ## Theme Sections Themes are some important sections to be aware of: diff --git a/docs/configuration/config-files.md b/docs/configuration/config-files.md index f76091ec..565b9b10 100644 --- a/docs/configuration/config-files.md +++ b/docs/configuration/config-files.md @@ -8,6 +8,8 @@ ENiGMA½ configuration files such as the [system config](config-hjson.md), [menu ## Hot-Reload Nearly all of ENiGMA½'s configuration can be hot-reloaded. That is, a live system can have it's configuration modified and it will be loaded in place. +:bulb: [Monitoring live logs](/docs/troubleshooting/monitoring-logs.md) is useful when making live changes. The system will complain if something is wrong! + ## Common Directives ### Includes Most configuration files offer an `includes` directive that allows users to break up large configuration files into smaller and organized parts. For example, consider a system with many menus/screens. Instead of a single `menu.hjson`, the SysOp may break this into `message-base.hjson`, `file-base.hjson`, etc. @@ -95,9 +97,9 @@ Below is a table of the various forms: | `@environment:SOME_VAR:timestamp` | "2020-01-05" | A [moment](https://momentjs.com/) object representing 2020-01-05 | | `@environment:SOME_VAR:timestamp:array` | "2020-01-05,2016-05-16T01:15:37'" | An array of [moment](https://momentjs.com/) objects representing 2020-01-05 and 2016-05-16T01:15:37 | -:information_source: `bool` may be used as an alias to `boolean`. +:bulb: `bool` may be used as an alias to `boolean`. -:information_source: `timestamp` values can be in any form that [moment can parse](https://momentjs.com/docs/#/parsing/). +:bulb: `timestamp` values can be in any form that [moment can parse](https://momentjs.com/docs/#/parsing/). :information_source: An unresolved or invalid `@environment` will be left intact. diff --git a/docs/configuration/event-scheduler.md b/docs/configuration/event-scheduler.md index 77b56f15..544e082a 100644 --- a/docs/configuration/event-scheduler.md +++ b/docs/configuration/event-scheduler.md @@ -6,7 +6,7 @@ title: Event Scheduler The ENiGMA½ scheduler allows system operators to configure arbitrary events that can can fire based on date and/or time, or by watching for changes in a file. Events can kick off internal handlers, custom modules, or binaries & scripts. ## Scheduling Events -To create a scheduled event, create a new configuration block in `config.hjson` under `eventScheduler.events`. +To create a scheduled event, create a new configuration block in `config.hjson` under `eventScheduler.events`. Events can have the following members: @@ -17,7 +17,7 @@ Events can have the following members: | `args` | :-1: | An array of arguments to pass along to the method or binary specified in `action`. | ### Schedules -As mentioned above, `schedule` may contain a [Later style](https://bunkat.github.io/later/parsers.html#text) parsable schedule string and/or an `@watch` clause. +As mentioned above, `schedule` may contain a [Later style](https://bunkat.github.io/later/parsers.html#text) parsable schedule string and/or an `@watch` clause. `schedule` examples: * `every 2 hours` @@ -26,7 +26,7 @@ As mentioned above, `schedule` may contain a [Later style](https://bunkat.github An `@watch` clause monitors a specified file for changes and takes the following form: `@watch:` where `` is a fully qualified path. -:information_source: If you would like to have a schedule **and** watch a file for changes, place the `@watch` clause second and seperated with the word `or`. For example: `every 24 hours or @watch:/path/to/somefile.txt`. +:bulb: If you would like to have a schedule **and** watch a file for changes, place the `@watch` clause second and separated with the word `or`. For example: `every 24 hours or @watch:/path/to/somefile.txt`. ### Actions Events can kick off actions by calling a method (function) provided by the system or custom module in addition to executing arbritary binaries or scripts. diff --git a/docs/configuration/security.md b/docs/configuration/security.md index afc583aa..dc2a122d 100644 --- a/docs/configuration/security.md +++ b/docs/configuration/security.md @@ -26,7 +26,7 @@ Due to the nature of 2FA/OTP, even if enabled on your system, users must opt-in :warning: Serving 2FA/OTP registration links over insecure (HTTP) can expose secrets intended for the user and is **highly** discouraged! -:information_source: +ops can also manually enable or disable 2FA/OTP for a user using [oputil](/docs/admin/oputil.md), but this is generally discouraged. +:note: +ops can also manually enable or disable 2FA/OTP for a user using [oputil](/docs/admin/oputil.md), but this is generally discouraged. #### Recovery In the situation that a user loses their 2FA/OTP device (such as a lost phone with Google Auth), there are some options: diff --git a/docs/filebase/first-file-area.md b/docs/filebase/first-file-area.md index e61e5a25..a30e40f3 100644 --- a/docs/filebase/first-file-area.md +++ b/docs/filebase/first-file-area.md @@ -23,9 +23,9 @@ storageTags: { } ``` -:information_source: On their own, storage tags don't do anything — they are simply pointers to storage locations on your system. +:note: On their own, storage tags don't do anything — they are simply pointers to storage locations on your system. -:information_source: Remember that paths are case sensitive on most non-Windows systems! +:warning: Remember that paths are case sensitive on most non-Windows systems! ### Areas File base *Areas* are configured using the `fileBase.areas` configuration block in `config.hjson`. Each entry's block starts with an *area tag*. Valid members for an area are as follows: diff --git a/docs/installation/docker.md b/docs/installation/docker.md index 4071a018..c9473e2b 100644 --- a/docs/installation/docker.md +++ b/docs/installation/docker.md @@ -12,9 +12,9 @@ Download and run the ENiGMA½ BBS image: -p 8888:8888 \ davestephens/enigma-bbs:latest -:information_source: This is a **very basic** example! As no config has been supplied the container will use a basic one so that it starts successfully. Note that as no persistence directory has been supplied, once the container stops any changes made will be lost! +:warning: This is a **very basic** example! As no config has been supplied the container will use a basic one so that it starts successfully. Note that as no persistence directory has been supplied, once the container stops any changes made will be lost! -:information_source: [Volumes](https://docs.docker.com/storage/volumes/) may be used for things such as your configuration and database path. +:bulb: [Volumes](https://docs.docker.com/storage/volumes/) may be used for things such as your configuration and database path. ## Customized Docker Setup TBC using Docker Compose diff --git a/docs/installation/install-script.md b/docs/installation/install-script.md index 56da80cf..e6a3a445 100644 --- a/docs/installation/install-script.md +++ b/docs/installation/install-script.md @@ -9,7 +9,7 @@ Under most Linux/UNIX like environments (Linux, BSD, OS X, ...) new users can s curl -o- https://raw.githubusercontent.com/NuSkooler/enigma-bbs/master/misc/install.sh | bash ``` -:information_source: You may wish to review the [installation script](https://raw.githubusercontent.com/NuSkooler/enigma-bbs/master/misc/install.sh) +:heavy_check_mark: You may wish to review the [installation script](https://raw.githubusercontent.com/NuSkooler/enigma-bbs/master/misc/install.sh) on GitHub before running it! The script will install `nvm`, Node.js and grab the latest ENiGMA BBS from GitHub. It will also guide you through creating a basic configuration file, and recommend some packages to install. diff --git a/docs/installation/manual.md b/docs/installation/manual.md index 46fc301d..2dcbfca7 100644 --- a/docs/installation/manual.md +++ b/docs/installation/manual.md @@ -7,7 +7,7 @@ do things manually, read on... ## Prerequisites * [Node.js](https://nodejs.org/) version **v12.x LTS or higher** (Other versions may work but are not supported). - * :information_source: It is **highly** recommended to use [Node Version Manager (NVM)](https://github.com/creationix/nvm) to manage your Node.js installation if you're on a Linux/Unix environment. + * :bulb: It is **highly** recommended to use [Node Version Manager (NVM)](https://github.com/creationix/nvm) to manage your Node.js installation if you're on a Linux/Unix environment. * [Python](https://www.python.org/downloads/) for compiling Node.js packages with native extensions via `node-gyp`. diff --git a/docs/messageareas/configuring-a-message-area.md b/docs/messageareas/configuring-a-message-area.md index 394b3aa6..74c7dcb5 100644 --- a/docs/messageareas/configuring-a-message-area.md +++ b/docs/messageareas/configuring-a-message-area.md @@ -10,7 +10,7 @@ Message Conferences are the top level container for *1:n* Message *Areas* via th Each conference is represented by a entry under `messageConferences`. Each entries top level key is it's *conference tag*. -:information_source: It is **highly** recommended to use snake_case style message *conference tags* and *area tags*! +:bulb: It is **highly** recommended to use snake_case style message *conference tags* and *area tags*! | Config Item | Required | Description | |-------------|----------|-------------| diff --git a/docs/messageareas/ftn.md b/docs/messageareas/ftn.md index 54face6b..276d28de 100644 --- a/docs/messageareas/ftn.md +++ b/docs/messageareas/ftn.md @@ -70,7 +70,7 @@ Example: } ``` -:information_source: You can import `AREAS.BBS` or FTN style `.NA` files using [oputil](/docs/admin/oputil.md)! +:note: You can import `AREAS.BBS` or FTN style `.NA` files using [oputil](/docs/admin/oputil.md)! #### A More Complete Example Below is a more complete *example* illustrating some of the concepts above: