From 98b2ce9df9af11073c17a04a8eb94f83298e19f7 Mon Sep 17 00:00:00 2001 From: Tasos Bitsios Date: Mon, 13 Jan 2025 16:35:22 +0100 Subject: [PATCH] Docs: Inline "Bash" missing docs; change docs label on landing page --- .../content/docs/guides/getting-started.md | 19 +++--- docs/src/content/docs/troubleshooting.md | 34 ---------- .../troubleshooting/10-getting-started.md | 38 ----------- .../docs/troubleshooting/20-bootstrap.md | 64 ------------------- .../30-generate-participation-keys.md | 30 --------- docs/src/pages/index.astro | 2 +- 6 files changed, 12 insertions(+), 175 deletions(-) delete mode 100644 docs/src/content/docs/troubleshooting/10-getting-started.md delete mode 100644 docs/src/content/docs/troubleshooting/20-bootstrap.md delete mode 100644 docs/src/content/docs/troubleshooting/30-generate-participation-keys.md diff --git a/docs/src/content/docs/guides/getting-started.md b/docs/src/content/docs/guides/getting-started.md index e83cf4fa..c4fb739a 100644 --- a/docs/src/content/docs/guides/getting-started.md +++ b/docs/src/content/docs/guides/getting-started.md @@ -20,9 +20,7 @@ To get started with NodeKit, copy-paste this command in your terminal: curl -fsSL https://nodekit.run/install.sh | bash ``` -
-Troubleshooting: Command 'curl' not found - +
Troubleshooting: Command 'curl' not found If you get an error about the `curl` command not being found, you need to install the `curl` package. On Ubuntu systems, you do this with: @@ -30,7 +28,17 @@ On Ubuntu systems, you do this with: ```bash sudo apt install -y curl ``` +
+
Troubleshooting: Command 'bash' not found +Some versions of Mac OS may not include the required `bash` executable that runs the installer. + +If you get an error about `bash` not being available, please install bash on your system manually. + +For Mac OS, a popular way to do this is to install [Homebrew](https://brew.sh/) and then install bash using: +```bash +brew install bash +```
This will detect your operating system and download the appropriate NodeKit executable to your local directory. @@ -39,9 +47,4 @@ It will then immediately start the bootstrap process to get your Algorand node u ![Screenshot of a typical NodeKit installation process](/assets/nodekit-install.png) -:::note -**Did you encounter any errors?** -Check out the [Troubleshooting: Getting Started](/troubleshooting#getting-started-with-nodekit) section. -::: - Otherwise, read on for guidance on the bootstrapping process. diff --git a/docs/src/content/docs/troubleshooting.md b/docs/src/content/docs/troubleshooting.md index 637c51fc..ac8c5dbf 100644 --- a/docs/src/content/docs/troubleshooting.md +++ b/docs/src/content/docs/troubleshooting.md @@ -8,40 +8,6 @@ next: This page contains troubleshooting tips for common issues that you might run into. For additional support, please visit our [Discord channel](https://discord.com/channels/491256308461207573/807825288666939482). -## Getting started with NodeKit - -:::note -This section outlines **common errors encountered** when executing the nodekit installation command. - -**If you are looking for the installation instructions instead, they are located [here](/guides/10-getting-started).** -::: - -### A nodekit file already exists in the current directory. - -If you run the installer command more than once, you will see: - -> ERROR: A nodekit file already exists in the current directory. Delete or rename it before installing. - -If you want to fetch the latest version of nodekit, you can delete the existing file: - -```bash -rm nodekit -``` - -And then run the [Getting Started](/guides/10-getting-started) command again. - -### Command not found: bash - -Some versions of Mac OS may not include the required `bash` executable that runs the installer. - -If you get an error about `bash` not being available, please install bash on your system manually. - -For Mac OS, a popular way to do this is to install [Homebrew](https://brew.sh/) and then install bash using: - -```bash -brew install bash -``` - ## Bootstrapping the Algorand node :::note diff --git a/docs/src/content/docs/troubleshooting/10-getting-started.md b/docs/src/content/docs/troubleshooting/10-getting-started.md deleted file mode 100644 index 7d08e4b8..00000000 --- a/docs/src/content/docs/troubleshooting/10-getting-started.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Troubleshooting: Getting Started with NodeKit" -sidebar: - label: "Getting Started with NodeKit" -description: Troubleshooting nodekit installation ---- - -:::note -This section outlines **common errors encountered** when executing the nodekit installation command. - -**If you are looking for the installation instructions instead, they are located [here](/guides/10-getting-started).** -::: - -### A nodekit file already exists in the current directory. - -If you run the installer command more than once, you will see: - -> ERROR: A nodekit file already exists in the current directory. Delete or rename it before installing. - -If you want to fetch the latest version of nodekit, you can delete the existing file: - -```bash -rm nodekit -``` - -And then run the [Getting Started](/guides/10-getting-started) command again. - -### Command not found: bash - -Some versions of Mac OS may not include the required `bash` executable that runs the installer. - -If you get an error about `bash` not being available, please install bash on your system manually. - -For Mac OS, a popular way to do this is to install [Homebrew](https://brew.sh/) and then install bash using: - -```bash -brew install bash -``` diff --git a/docs/src/content/docs/troubleshooting/20-bootstrap.md b/docs/src/content/docs/troubleshooting/20-bootstrap.md deleted file mode 100644 index 752e6638..00000000 --- a/docs/src/content/docs/troubleshooting/20-bootstrap.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "Installation/Bootstrapping" -description: Troubleshooting nodekit bootstrap ---- - -:::note -This section outlines **common errors encountered** during the "bootstrap" node installation process. - -**If you are looking for the instructions instead, they are located [here](/guides/20-bootstrap).** -::: - -### Asking for password - -The installer will ask for your user password during this process. This is required by your operating system in order to install new software. - -Enter your operating system user password when you see this prompt: - -``` -[sudo] password for user: -``` - -### Fast catchup is taking too long to complete - -If the fast catchup process is taking too long to complete, check the following: - -#### Status is in FAST-CATCHUP - -The colored status at the top of Nodekit should be in a yellow `FAST-CATCHUP` state: - -![](/assets/nodekit-state-fast-catchup.png) - -After fast-catchup completes successfully, it is normal for a node to be in a `SYNCING` state for a few minutes: - -![](/assets/nodekit-state-syncing.png) - -During this the `Latest Round` number should be increasing rapidly. - -If there is no progress for a while, or the Latest Round value is smaller than `46000000` (46 million) then you should start fast-catchup again: - -#### Fast Catchup was interrupted or did not complete - -To start the fast catchup process again, exit the Nodekit user interface by pressing `Q` and enter the following command: - -```bash -./nodekit catchup -``` - -You can enter nodekit again by running: - -```bash -./nodekit -``` - -When the syncing process completes, the status will display `RUNNING`: - -![](/assets/nodekit-state-running.png) - -### Your hardware meets the minimum specs - -TODO SSD - -### Your network connection meets the minimum specs - -TODO diff --git a/docs/src/content/docs/troubleshooting/30-generate-participation-keys.md b/docs/src/content/docs/troubleshooting/30-generate-participation-keys.md deleted file mode 100644 index ec1d074c..00000000 --- a/docs/src/content/docs/troubleshooting/30-generate-participation-keys.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Participation key generation" -description: Troubleshooting participation key generation with Nodekit ---- - -:::note -This section outlines **common errors encountered** during the participation key generation step on Nodekit. - -**If you are looking for the instructions instead, they are located [here](/guides/30-generate-participation-keys).** -::: - -### Failed to get participation keys - -Occasionally, Nodekit may fall out of sync with the Algorand node while waiting for the participation keys to be generated. In this case this error message will be shown: - -You can: - -- wait for the participation keys to appear in the Accounts list -- try to generate a participation key again - - If the key generation process is still running on the node, you will see a ["Participation key generation already in progress"](#participation-key-generation-already-in-progress) error - -![](/assets/nodekit-error-keygen-failed.png) - -### Participation key generation already in progress - -This error means that there is a participation key already being generated on the Algorand node. - -You can wait a few minutes, and the key will automatically appear in the Accounts list when it is ready. - -![](/assets/nodekit-error-keygen-already.png) diff --git a/docs/src/pages/index.astro b/docs/src/pages/index.astro index 8406f0a8..6d7c753f 100644 --- a/docs/src/pages/index.astro +++ b/docs/src/pages/index.astro @@ -110,7 +110,7 @@ export const lang = "en"; Documentation + >Guides & Documentation