Skip to content

Commit 872d82f

Browse files
author
Kellian Leveque
committed
docs(getting-started): Improve clarity and formatting
1 parent 7f63b2e commit 872d82f

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

docs/getting_started.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
In this tutorial, we will guide you through the first steps to get started with PowerAPI.
44
The objective is to get a quick view of the capabilities of PowerAPI, by monitoring a process and getting a quick glimpse at the energy consumption.
5-
A few things are required before we start :
5+
A few things are required before we start:
66

7-
- A compatible processor, you can see the compatible CPU architecture [here](./reference/sensors/hwpc-sensor.md#) and you can look on the following pages to find your CPU architecture :
7+
- A compatible processor (you can see the compatible CPU architecture [here](./reference/sensors/hwpc-sensor.md#)), and you can look on the following pages to find your CPU architecture:
88
* For [Intel Processor](https://en.wikipedia.org/wiki/List_of_Intel_processors)
99
* For [Intel Xeon Processor](https://en.wikipedia.org/wiki/List_of_Intel_Xeon_processors)
1010
* For [AMD Processor](https://en.wikipedia.org/wiki/Table_of_AMD_processors)
1111
- A python installation ready
1212
- Docker & Docker-Compose ready (refer to [this official documentation](https://docs.docker.com/engine/install/) and the [post-install steps](https://docs.docker.com/engine/install/linux-postinstall/) if needed !)
1313
- Root access
14-
- Optionnal : [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) to proceed by clonning the repository
14+
- Optional : [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) to proceed by clonning the repository
1515

1616
## Which components to get a complete stack
1717

18-
If you wish to get started as soon as possible, the following archive will allow you to deploy the following elements :
18+
If you wish to get started as soon as possible, the archive below will allow you to deploy the following elements:
1919

2020
1. A MongoDB instance to store the [Sensor](./reference/sensors/hwpc-sensor.md)
2121
Reports
@@ -32,50 +32,50 @@ quick glimpse
3232

3333
## Preparation
3434

35+
You can either download the archive by cloning the repository or using wget.
3536

36-
1. Clone the repository:
37-
```sh
38-
git clone https://github.com/powerapi-ng/powerapi-ng.github.io.git
39-
cd powerapi-ng.github.io/docs/script/getting-started
40-
```
41-
42-
2. Download the archive:
43-
```
44-
wget -c https://raw.githubusercontent.com/powerapi-ng/powerapi-ng.github.io/refs/heads/master/docs/script/getting_started.tar.gz -O - | tar -xz
45-
cd getting_started
46-
```
37+
=== "git"
38+
```sh
39+
git clone https://github.com/powerapi-ng/powerapi-ng.github.io.git
40+
cd powerapi-ng.github.io/docs/script/getting-started
41+
```
4742

48-
From this archive, you will have all the necessary files to get started, let us break down each element.
43+
=== "wget"
44+
```
45+
wget -c https://raw.githubusercontent.com/powerapi-ng/powerapi-ng.github.io/refs/heads/master/docs/script/getting_started.tar.gz -O - | tar -xz
46+
cd getting_started
47+
```
4948

49+
At this stage, you will have all the essential files to begin. Let's go through each element in detail.
5050
### Archive content
5151

5252
```sh
53-
|getting_started/
54-
|--csv/
55-
|--fomula/
56-
|----smartwatts-mongodb-csv.json
57-
|--sensor/
58-
|----hwpc-mongodb.json
59-
|--start.sh
60-
|--start.py
61-
|--stop.sh
62-
|--pretty_print.py
63-
|--docker-compose.yaml
64-
|--.env
53+
getting_started/
54+
|--csv/
55+
|--fomula/
56+
|----smartwatts-mongodb-csv.json
57+
|--sensor/
58+
|----hwpc-mongodb.json
59+
|--start.sh
60+
|--start.py
61+
|--stop.sh
62+
|--pretty_print.py
63+
|--docker-compose.yaml
64+
|--.env
6565
```
6666

6767
#### HWPC-Sensor and SmartWatts Configuration
6868

69-
As described in the [HWPC-Sensor Documentation](./reference/sensors/hwpc-sensor.md#global-parameters) and in the [SmartWatts Documentation](./reference/formulas/smartwatts.md#global-parameters)
69+
As described in the [HWPC-Sensor Documentation](./reference/sensors/hwpc-sensor.md#global-parameters) and in the [SmartWatts Documentation](./reference/formulas/smartwatts.md#global-parameters),
7070
several parameters can be set, both globally and for specific Groups monitored for the sensor or the formula.
7171

72-
The provided docker-compose.yaml file use configuration files and the **.env** to set those parameters.
73-
You can find example of both those configuration files in the archive under the **formula** and **sensor** directories.
72+
The provided docker-compose.yaml file uses configuration files and the **.env** to set those parameters.
73+
You can find examples of both those configuration files in the archive under the **formula** and **sensor** directories.
7474

7575

7676
## Turn the key
7777

78-
Once all set, you shall be able to initiate the stack with :
78+
Once all set, you shall be able to initiate the stack with:
7979

8080
```sh
8181
python3 start.py

0 commit comments

Comments
 (0)