Add introduction page listing various node running options (#24)

VoiNetwork · Feb 2, 2024 · c06abda · c06abda
1 parent 7f96c25
commit c06abda
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 6 deletions.
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -1,6 +1,6 @@
 {
   "MD013": {
-    "line_length": 256
+    "line_length": 512
   },
   "MD033": {
     "allowed_elements": ["img"]

diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md
@@ -0,0 +1,15 @@
+# Introduction
+
+Welcome to the documentation for Voi Swarm. Delighted to have you here :tophat:
+
+Voi Swarm provides a straightforward entry to the Voi network. However, its opinionated design may not fit all use cases.
+Before you get started with running a node, it's important to evaluate options and understand the requirements.
+
+## What Node Running Options Are Available?
+
+| Method                                                                | Perfect for                                                                                          | Platform          |
+|-----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|-------------------|
+| [Voi Swarm](../../installation/system-requirements)                   | You want to explore, and possibly join the network by using a dedicated server.                      | Linux             |
+| [Austs One Click Node](https://github.com/AustP/austs-one-click-node) | You want to explore what Voi is about, and with an easy graphical interface and with no commitment.  | Windows/Linux/Mac |
+| [D13 guide](https://d13.co/posts/set-up-voi-participation-node/)      | Understanding the setup process and with more control (advanced use case, and no longer recommended) | Linux             |
+| Roll your own                                                         | You have a specific use case that doesn't fit the above options.                                     | Any               |
diff --git a/docs/installation/system-requirements.md b/docs/installation/system-requirements.md
@@ -7,6 +7,9 @@
 | Debian            | arm64/amd64       |
 | Ubuntu            | arm64/amd64       |
 
+!!! tip
+    Don't have Linux and want to run a node? [Other options are available](../../getting-started/introduction/)
+
 ## Compute Requirements and Recommendations
 
 | Minimum Requirements | Recommended Requirements |

diff --git a/docs/operating/running-your-node.md b/docs/operating/running-your-node.md
@@ -9,11 +9,13 @@ that allow you to manage common blockchain actions. The Voi CLI tools are instal
 As a participant, it's important that you continuously monitor the health of your node, this includes monitoring system
 metrics, node health as well as ensuring participation keys are up-to-date.
 
-| Metrics                  | Description                                   | How to Monitor                                                                                                                                       | Feature in Voi Swarm |
-|--------------------------|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|
-| Compute platform metrics | CPU load, disk usage, network bandwidth, etc. | Use cloud / system monitoring tools, [Voi Checker](https://github.com/crypto-morph/voi-checker)                                                      | :material-minus:     |
-| Node health              | Node status, participation status, etc.       | Use [Voi Checker](https://github.com/crypto-morph/voi-checker) and [Voi Proposer Data](https://cswenor.github.io/voi-proposer-data/health.html)      | :material-minus:     |
-| Participation keys       | Participation key status and expiration       | Use [CLI tools](../cli-tools.md) to check participation status and setup. Voi Swarm offers [notifications on key expiration](../setup-notifications) | :material-plus:      |
+| Metrics                  | Description                                   | How to Monitor                                                                                                                                                                                              | Feature in Voi Swarm |
+|--------------------------|-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|
+| Compute platform metrics | CPU load, disk usage, network bandwidth, etc. | Use cloud / system monitoring tools, [Voi Checker](https://github.com/crypto-morph/voi-checker)                                                                                                             | :material-minus:     |
+| Node health              | Node status, participation status, etc.       | Use [Voi Checker](https://github.com/crypto-morph/voi-checker), [Voi Proposer Data](https://cswenor.github.io/voi-proposer-data/health.html), [Voi-Node Metrics](https://voi-node-info.boeieruurd.com/)[^1] | :material-minus:     |
+| Participation keys       | Participation key status and expiration       | Use [CLI tools](../cli-tools.md) to check participation status and setup. Voi Swarm offers [notifications on key expiration](../setup-notifications)                                                        | :material-plus:      |
 
 Contributions to improve the health monitoring of the Voi node are welcome.
 Please join the [Voi Network Discord server](https://discord.com/invite/vnFbrJrHeW) to discuss with other community members and contributors. You can also open an issue or a pull request on GitHub.
+
+[^1]: If Voi-Node Metrics doesn't display your node, use Voi Proposer Data. This known issue is being worked on.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -68,6 +68,7 @@ markdown_extensions:
   - admonition
   - pymdownx.details
   - pymdownx.superfences
+  - footnotes
 
 plugins:
   - search
@@ -82,6 +83,8 @@ extra_css:
 
 nav:
   - Home: index.md
+  - Getting Started:
+        - Introduction: getting-started/introduction.md
   - Installation:
         - System requirements: installation/system-requirements.md
         - Prerequisites: installation/prerequisites.md