Skip to content

Commit

Permalink
docs: clean docs from typos (#20)
Browse files Browse the repository at this point in the history
* docs: remove typos in quickstart

* docs: update references to k3s
  • Loading branch information
paoloyx authored Jun 24, 2024
1 parent 3f9f39c commit 61f0e05
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This repository contains all the files and projects to run Radicalbit AI Monitor

## 🚀 Installation using Docker compose

In this repository a docker compose file is available to run the platform in local with a k3s cluster where we can deploy Spark jobs.
In this repository a docker compose file is available to run the platform in local with a K3s cluster where we can deploy Spark jobs.

To run, simply:

Expand All @@ -50,17 +50,17 @@ docker compose --profile ui up

After all containers are up & running, you can go to [http://localhost:5173](http://127.0.0.1:5173) to play with the app.

### Interacting with k3s cluster
### Interacting with K3s cluster

In the compose file is present a [k9s](https://k9scli.io/) container that can be used to monitor the k3s cluster.
In the compose file is present a [k9s](https://k9scli.io/) container that can be used to monitor the K3s cluster.

```bash
docker compose up k9s -d && docker attach radicalbit-ai-monitoring-k9s-1
```

#### Other tools

In order to connect and interact with the k3s cluster from the local machine (for example with Lens or `kubectl`) is necessary to create another file starting from `./docker/k3s_data/kubeconfig/kubeconfig.yaml` (that is automatically generated when the docker compose is up and running).
In order to connect and interact with the K3s cluster from the local machine (for example with Lens or `kubectl`) is necessary to create another file starting from `./docker/k3s_data/kubeconfig/kubeconfig.yaml` (that is automatically generated when the docker compose is up and running).

Copy the above file and modify `https://k3s:6443` with `https://127.0.0.1:6443` and use this new file to interact with the cluster from the local machine

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/user-guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Once you've installed Docker and Docker Compose, clone the repository to your lo
git clone [email protected]:radicalbit/radicalbit-ai-monitoring.git
```

This repository provides a Docker Compose file to set up the platform locally alongside a Rancher Kubernetes cluster. This allows you to deploy Spark jobs within the cluster.
This repository provides a Docker Compose file to set up the platform locally alongside a K3s Kubernetes cluster. This allows you to deploy Spark jobs within the cluster.

For streamlined development and testing, you can execute these steps to run the platform locally without the graphical user interface:

Expand All @@ -43,7 +43,7 @@ After all containers are up and running, you can access the platform at [http://
#### Accessing the Kubernetes Cluster
The platform creates a Kubernetes cluster for managing deployments. You can connect and interact with this cluster from your local machine using tools like Lens or `kubectl`.

In the compose file is present a [k9s](https://k9scli.io/) container that can be used to monitor the k3s cluster.
In the compose file is present a [k9s](https://k9scli.io/) container that can be used to monitor the K3s cluster.

```bash
docker compose up k9s -d && docker attach radicalbit-ai-monitoring-k9s-1
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/user-guide/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ What follows is an exemple of data we will use in this tutorial:

| timestamp | user_id | question | model_answer | ground_truth | prediction | gender | age | device | days_as_customer |
|-----------|--------:|:---------|:-------------|-------------:|-----------:|:-------|----:|:-------|-----------------:|
|2024-01-11 08:08:00|user_24:|What documents do I need to open a business account?|You need a valid ID, proof of address, and business registration documents.|1|1|M|44|smartphone|194|
|2024-01-11 08:08:00|user_24|What documents do I need to open a business account?|You need a valid ID, proof of address, and business registration documents.|1|1|M|44|smartphone|194|
|2024-01-10 03:08:00|user_27|What are the benefits of a premium account?|The benefits of a premium account include higher interest rates and exclusive customer support.|1|1|F|29|tablet|258|
2024-01-11 12:22:00|user_56|How can I check my credit score?|You can check your credit score for free through our mobile app.|1|1|F|44|smartphone|51|
2024-01-10 04:57:00|user_58|Are there any fees for using ATMs?|ATM usage is free of charge at all locations.|1|1|M|50|smartphone|197|
Expand Down

0 comments on commit 61f0e05

Please sign in to comment.