Skip to content

Commit

Permalink
docs: multiple improvements (#498)
Browse files Browse the repository at this point in the history 
* docs: multiple improvements

- Improve markdown style
- Rework Kubernetes and Kurtosis sections
- Add Storages section
- Remove broken link

* link env vars

* format + background jobs
  • Loading branch information
@PabloCastellano
PabloCastellano authored Aug 26, 2024
1 parent a36786f commit 4875a48
Show file tree
Hide file tree
Showing 14 changed files with 140 additions and 78 deletions.
Binary file removed apps/docs/public/blobscan-kurtosis-light.png
View file
Binary file not shown.
0 apps/docs/public/blobscan-kurtosis-dark.png → apps/docs/public/blobscan-kurtosis.png
View file
File renamed without changes
10 changes: 5 additions & 5 deletions apps/docs/src/app/docs/clis/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ pnpm start <command>

### Create Command

Following is the usage guide for the create command:
Following is the usage guide for the `create` command:

```bash
Create Command
Expand All @@ -45,7 +45,7 @@ Options

### Remove Command

Following is the usage guide for the remove command:
Following is the usage guide for the `remove` command:

```bash
Remove Command
Expand All @@ -64,7 +64,7 @@ Options

### Retry Command

Following is the usage guide for the retry command:
Following is the usage guide for the `retry` command:

```bash
Retry Command
Expand Down Expand Up @@ -92,7 +92,7 @@ pnpm start <command>

### Daily Command

Following is the usage guide for the daily command:
Following is the usage guide for the `daily` command:

```bash
Daily Command
Expand All @@ -112,7 +112,7 @@ Options

### Overall Command

Following is the usage guide for the overall command:
Following is the usage guide for the `overall` command:

```bash
Overall Command
Expand Down
43 changes: 21 additions & 22 deletions apps/docs/src/app/docs/environment/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,27 @@ nextjs:
description: How to configure your Blobscan instance
---

# Blobscan Web
## Blobscan Web

| Variable | Description | Required | Default value |
| -------------------------------------- | ------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `DATABASE_URL` | Postgresql database URI | Yes | (empty) |
| `BLOBSCAN_API_PORT` | Port where Blobscan API is listening | No | `3001` |
| `FEEDBACK_WEBHOOK_URL` | Discord webhook URL for feedback | No | (empty) |
| `NEXT_PUBLIC_NETWORK_NAME` | Network name | No | mainnet |
| `NEXT_PUBLIC_EXPLORER_BASE_URL` | Block explorer URL | No | `https://etherscan.io` |
| `NEXT_PUBLIC_BEACON_BASE_URL` | Beacon explorer URL | No | `https://beaconcha.in/` |
| `NEXT_PUBLIC_VERSION` | Blobscan version | No | (empty) |
| `NEXT_PUBLIC_SUPPORTED_NETWORKS` | Link to other pages from the Network menu | No | `[{"label":"Ethereum Mainnet","href":"https://blobscan.com/"},{"label":"Gnosis","href":"https://gnosis.blobscan.com/"},{"label":"Holesky Testnet","href":"https://holesky.blobscan.com/"},{"label":"Sepolia Testnet","href":"https://sepolia.blobscan.com/"}]` |
| `NEXT_PUBLIC_VERCEL_ANALYTICS_ENABLED` | Enable Vercel analytics | No | `false` |
| `NEXT_PUBLIC_SENTRY_DSN_WEB` | Sentry DSN | No | (empty) |
| `NODE_ENV` | Used in Node.js applications to specify the environment in which the application is running | No | (empty) |
| `SENTRY_PROJECT` | Sentry project name | No | (empty) |
| `SENTRY_ORG` | Sentry organization | No | (empty) |
| `METRICS_ENABLED` | Expose the /metrics endpoint | No | `false` |
| `TRACES_ENABLED` | Enable instrumentation of functions and sending traces to a collector | No | `false` |
| `BLOB_PROPAGATOR_ENABLED` | Enable uploading blobs to multiple storages in parallel | No | `false` |
| Variable | Description | Required | Default value |
| ---------------------------------------- | ------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `DATABASE_URL` | Postgresql database URI | Yes | (empty) |
| `FEEDBACK_WEBHOOK_URL` | Discord webhook URL for feedback | No | (empty) |
| `NEXT_PUBLIC_NETWORK_NAME` | Network name | No | mainnet |
| `NEXT_PUBLIC_EXPLORER_BASE_URL` | Block explorer URL | No | `https://etherscan.io` |
| `NEXT_PUBLIC_BEACON_BASE_URL` | Beacon explorer URL | No | `https://beaconcha.in/` |
| `NEXT_PUBLIC_VERSION` | Blobscan version | No | (empty) |
| `NEXT_PUBLIC_SUPPORTED_NETWORKS` | Link to other pages from the Network menu | No | `[{"label":"Ethereum Mainnet","href":"https://blobscan.com/"},{"label":"Gnosis","href":"https://gnosis.blobscan.com/"},{"label":"Holesky Testnet","href":"https://holesky.blobscan.com/"},{"label":"Sepolia Testnet","href":"https://sepolia.blobscan.com/"}]` |
| `NEXT_PUBLIC_VERCEL_ANALYTICS_ENABLED` | Enable Vercel analytics | No | `false` |
| `NEXT_PUBLIC_SENTRY_DSN_WEB` | Sentry DSN | No | (empty) |
| `NODE_ENV` | Used in Node.js applications to specify the environment in which the application is running | No | (empty) |
| `SENTRY_PROJECT` | Sentry project name | No | (empty) |
| `SENTRY_ORG` | Sentry organization | No | (empty) |
| `METRICS_ENABLED` | Expose the /metrics endpoint | No | `false` |
| `TRACES_ENABLED` | Enable instrumentation of functions and sending traces to a collector | No | `false` |
| `BLOB_PROPAGATOR_ENABLED` | Enable uploading blobs to multiple storages in parallel | No | `false` |

# Blobscan API
## Blobscan API

| Variable | Description | Required | Default value |
| ------------------------------------ | -------------------------------------------------------------------------------------------------- | ------------------------------- | -------------------------- |
Expand Down Expand Up @@ -62,7 +61,7 @@ nextjs:
| `BLOB_PROPAGATOR_COMPLETED_JOBS_AGE` | Remove completed jobs after the specified number of seconds (default: 1 day) | No | `86400` |
| `BLOB_PROPAGATOR_FAILED_JOBS_AGE` | Remove completed jobs after the specified number of seconds (default: 7 days) | No | `604800` |

# Blobscan indexer
## Blobscan indexer

| Variable | Description | Required | Default value |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------- |
Expand All @@ -75,7 +74,7 @@ nextjs:
| `RUST_LOG` | Configure logger | No | `blob-indexer=INFO` |
| `SENTRY_DSN` | Sentry DSN | No | (empty) |

# Docker
## Docker

These variables are used in the docker compose files we provide.

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/app/docs/how-to-contribute/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ All contributors are expected to follow our [Code of Conduct](/docs/code-of-cond

## Making Changes

- Begin by [setting up Blobscan locally](/docs/running-locally).
- Begin by [setting up Blobscan locally](/docs/running-blobscan-locally).
- Proceed to make your changes.
- Ensure you've tested your changes comprehensively. Refer to our [Testing Guide](/docs/testing) for details on our testing setup.
- Once done, push your changes to your GitHub fork.
Expand Down
1 change: 1 addition & 0 deletions apps/docs/src/app/docs/indexer/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ Using environment variables

```bash
docker run --rm \
-e SECRET_KEY=supersecret \
-e BLOBSCAN_API_ENDPOINT=http://blobscan-api:3001 \
-e BEACON_NODE_ENDPOINT=http://beacon:3500 \
-e EXECUTION_NODE_ENDPOINT=http://execution:8545 \
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/app/docs/installation/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Check out the [blobscan-helm-charts](https://github.com/Blobscan/blobscan-helm-c

### Local environment

Check out [Running locally](/docs/running-locally).
Check out [Running locally](/docs/running-blobscan-locally).

### Background jobs

Expand Down
65 changes: 65 additions & 0 deletions apps/docs/src/app/docs/running-blobscan-k8s/page.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: Deploy in Kubernetes
nextjs:
metadata:
title: Deploy in Kubernetes
description: Run Blobscan using our Helm Charts
---

A set of Helm charts are provided to run multiple Blobscan components on Kubernetes.

{% callout title="Tip" %}
If you want to try the Helm Charts without setting up a whole Kubernetes clusters, you can create a localy [Kind](https://kind.sigs.k8s.io/) cluster.
{% /callout %}

```bash
kind create cluster
kubectl cluster-info --context kind-kind
```

## Installing helm chart

First you will need to add a new repository:

```bash
helm repo add blobscan-helm-charts https://blobscan.github.io/blobscan-helm-charts
```

Then retrieve the packages in the repository an install:

```bash
helm repo update
helm install blobscan blobscan-helm-charts/blobscan
```

The easiest way is installing `blobscan`, which is an umbrella chart which will install `blobscan-api`, `blobscan-web` and `blobscan-indexer`.

## List of helm charts available

```bash
helm search repo blobscan-helm-charts
```

| Name | Description |
| ------------------------------------- | ------------------- |
| blobscan-helm-charts/blobscan | Blobscan meta-chart |
| blobscan-helm-charts/blobscan-api | Blobscan API |
| blobscan-helm-charts/blobscan-indexer | Blobscan indexer |
| blobscan-helm-charts/blobscan-web | Blobscan Web UI |

## Uninstalling blobscan

Remove blobscan:

```bash
helm ls
helm uninstall blobscan
```

{% callout title="Tip" %}
If you used a local Kind cluster.
{% /callout %}

```bash
kind delete cluster
```
33 changes: 0 additions & 33 deletions apps/docs/src/app/docs/running-blobscan-kind/page.md
View file

This file was deleted.

Loading

0 comments on commit 4875a48

Please sign in to comment.