Skip to content

Commit

Permalink
docs: Separate installation commands per OS; inline troubleshooting
Browse files Browse the repository at this point in the history
  • Loading branch information
Tasos Bitsios committed Jan 13, 2025
1 parent 98b2ce9 commit 0b70e35
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 32 deletions.
2 changes: 2 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";
import tailwind from "@astrojs/tailwind";
import mdx from '@astrojs/mdx';

// https://astro.build/config
export default defineConfig({
Expand Down Expand Up @@ -37,6 +38,7 @@ export default defineConfig({
},
customCss: ["./src/tailwind.css"],
}),
mdx(),
tailwind({ applyBaseStyles: true }),
],
});
8 changes: 6 additions & 2 deletions docs/src/content/docs/guides/bootstrap.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If there is none, it will ask if you want to start a node installation:
>
> It looks like you're running this for the first time. Would you like to install a node? (y/n)
You can respond by pressing the `Y` or `N` keys of your keyboard, for `Yes` and `No` respectively.
You can respond by pressing the `y` or `n` keys of your keyboard, for `Yes` and `No` respectively.

---

Expand All @@ -46,7 +46,11 @@ INFO Installing with apt-get
[sudo] password for user:
```

Your operating system requires this to allow NodeKit to install the Algorand node software. Enter your user password and press ENTER to proceed.
<details><summary>Why is the installer asking for my password?</summary>
The installer will ask for your user password during the node installation process.

This is required by your operating system in order to install new software.
</details>

## Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar:
order: 10
---

import { Tabs, TabItem } from '@astrojs/starlight/components';

Welcome to NodeKit, your command-line one-stop-shop for Algorand node running.

NodeKit can help you with:
Expand All @@ -16,29 +18,33 @@ NodeKit can help you with:

To get started with NodeKit, copy-paste this command in your terminal:

<Tabs syncKey="os">
<TabItem label="Linux">

```bash
curl -fsSL https://nodekit.run/install.sh | bash
wget -qO- https://nodekit.run/install.sh | bash
```
</TabItem>
<TabItem label="macOS">

<details><summary>Troubleshooting: Command 'curl' not found</summary>
If you get an error about the `curl` command not being found, you need to install the `curl` package.
```sh
curl -fsSL https://nodekit.run/install.sh | bash
```

On Ubuntu systems, you do this with:
</TabItem>
</Tabs>

```bash
sudo apt install -y curl
```
</details>
<details><summary>Troubleshooting: Command 'bash' not found</summary>
Some versions of Mac OS may not include the required `bash` executable that runs the installer.
<details>
<summary>Troubleshooting: Command 'bash' not found</summary>
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.
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:
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
```
```bash
brew install bash
```
</details>

This will detect your operating system and download the appropriate NodeKit executable to your local directory.
Expand Down
9 changes: 0 additions & 9 deletions docs/src/content/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,6 @@ This section outlines **common errors encountered** during the "bootstrap" node
**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

Expand Down
26 changes: 20 additions & 6 deletions docs/src/pages/index.astro
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
import { Code } from "@astrojs/starlight/components";
import { Icon } from "@astrojs/starlight/components";
import { Tabs, TabItem } from '@astrojs/starlight/components';
const base = import.meta.env.BASE_URL;
export const lang = "en";
Expand Down Expand Up @@ -101,12 +102,25 @@ export const lang = "en";
<div class="w-full h-svh mx-4">
<div
class="w-full h-svh flex gap-4 flex-col items-center justify-center px-6"
>
<Code
lang="shell"
code={`curl -fsSL https://nodekit.run/install.sh | bash`}
class="max-w-full z-10"
/>
>
<div class="mb-6">
<Tabs syncKey="os">
<TabItem label="Linux" icon="linux" style={{margin: 0}}>
<Code
lang="shell"
code={`wget -qO- https://nodekit.run/install.sh | bash`}
class="max-w-full z-10"
/>
</TabItem>
<TabItem label="macOS" icon="apple">
<Code
lang="shell"
code={`curl -fsSL https://nodekit.run/install.sh | bash`}
class="max-w-full z-10"
/>
</TabItem>
</Tabs>
</div>
<a
class="text-white/80 hover:text-[#BFBFF9]"
href="/guides/getting-started/"
Expand Down

0 comments on commit 0b70e35

Please sign in to comment.