Merge remote-tracking branch 'origin/7_doc/nld_proofread' into 7_doc/nld_proofread

# Conflicts:
#	docs/script/getting_started/formula/smartwatts-mongodb-csv.json
#	docs/script/getting_started/start.py
#	docs/script/getting_started/start.sh

Author: Zetos11

docs/assets/images/reference/sensors/PowerAPI_HWPCSensorOverview.drawio.svg

@@ -9,51 +9,10 @@ A few things are required before we start :
     * For [Intel Xeon Processor](https://en.wikipedia.org/wiki/List_of_Intel_Xeon_processors)  
     * For [AMD Processor](https://en.wikipedia.org/wiki/Table_of_AMD_processors)  
 - A python installation ready
-- Docker & Docker-Compose ready
+- 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 !)
 - Root access
+- Optionnal : [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) to proceed by clonning the repository
 
-The first step of the tutorial will be to define the elements to monitor. 
-In the testing archive, we will be able to see the consumption of the docker container by the default.
-So feel free to skip directly to the [preparation part](#preparation) if you don't want to monitor a specific process.
-
-## Define elements to monitor
-
-!!! tip "Optionnal abstraction for fine-grain analysis"
-    This part is optionnal, it allows the definition of cgroups which can group chosen processes that make sense to you.  
-    If you skip it, the next steps will work against all current process grouped.
-
-PowerAPI being a monitoring tool for energy consumption, we can define logic grouping of elements to monitor.
-To do so we can use the Linux abstraction of [cGroups](https://www.redhat.com/sysadmin/cgroups-part-one).  
-Kernel supports 2 versions of cGroups : v1 and v2. 
-To know which one your kernel supports, you can run :
-```sh
-mount | grep '^cgroup' | awk '{print $1}' | uniq
-```
-
-*Both versions can be supported at the same time*.
-
-??? "Create a cGroup"
-    
-    In order to create a cGroup, you can use:  
-
-    - cgroup v1 : [this doc](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/cgroups.html#usage-examples-and-syntax)  
-    - cgroup v2 : [this doc](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#mounting)  
-
-    
-    
-??? "Add processes to the group"
-    
-    Once the cgroup created, we need to fill it with processes to be monitored. 
-    To do so, you can use:  
-
-    - cgroup v1 : [this doc](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/cgroups.html#attaching-processes).  
-    - cgroup v2 : [this doc](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/cgroups.html#attaching-processes).  
-    
-??? warning "Installing a process to monitor"
-    
-    [stress-ng](https://wiki.ubuntu.com/Kernel/Reference/stress-ng) can be used to 
-    generate load on one's system. **Be carefull** as it can be configured to be quite agressive.
- 
 ## Which components to get a complete stack  
 
 If you wish to get started as soon as possible, the following archive will allow you to deploy the following elements :  
@@ -62,23 +21,30 @@ If you wish to get started as soon as possible, the following archive will allow
 Reports
 
 3. An [HWPC-Sensor](./reference/sensors/hwpc-sensor.md) that outputs its 
-[HWPCReports](./reference/reports/report.md#HWPCReport) in a MongoDB Database, 
-within the HWPCReport Collection
+[HWPC Reports](./reference/reports/reports.md#hwpc-reports) in a MongoDB Database, 
+within the HWPC Report Collection
 
 4. A [SmartWatts](./reference/formulas/smartwatts.md) that streams the 
-[HWPCReports](./reference/reports/report.md#HWPCReport) from the MongoDB 
+[HWPC Reports](./reference/reports/reports.md#hwpc-reports) from the MongoDB 
 Database Collection, processes it and outputs its 
-[PowerReports](./reference/reports/report.md#PowerReports) as CSV files for a 
+[Power Reports](./reference/reports/reports.md#power-reports) as CSV files for a 
 quick glimpse 
 
 ## Preparation
 
-Clone the repository and get ready:  
+
+1. Clone the repository:  
 ```sh 
 git clone https://github.com/powerapi-ng/powerapi-ng.github.io.git
 cd powerapi-ng.github.io/docs/script/getting-started
 ```
 
+2. Download the archive:
+```
+wget -c https://raw.githubusercontent.com/powerapi-ng/powerapi-ng.github.io/refs/heads/master/docs/script/getting_started.tar.gz -O - | tar -xz
+cd getting_started
+```
+
 From this archive, you will have all the necessary files to get started, let us break down each element.  
 
 ### Archive content
@@ -116,7 +82,7 @@ python3 start.py
 ```
 
 After the 2 minutes of monitoring, you will be able to see the result inside the **csv** directory.
-If you have trouble understanding the output, you can read the [Power Report documentation](./reference/reports/reports.md#power-Reports).
+If you have trouble understanding the output, you can read the [Power Report documentation](./reference/reports/reports.md#power-reports).
 
 !!! info "Quick results overview"
     Only in the context of this testing archive, after the monitoring, you can use the following command to get a pretty print of the result directly inside the terminal.  

docs/getting_started.md

@@ -34,7 +34,7 @@ The list of accepted parameters are:
 |`db` (`database` for `HWPCSensor`)           | string | `d` (`D` for `HWPCSensor`)            | N/A | Yes                                                       | The name of your database               |
 |`collection`   | string | `c` (`C` for `HWPCSensor`)          | N/A | Yes                                                       | The name of the collection inside `db`  |
 |`name`         | string | `n`           | `"puller_mongodb"` (Source), `pusher_mongodb` (Destination)| No | The related puller/pusher name. This parameter is not used by `HWPCSensor`                 |
-|`model`        | string | `m`           | `"HWPCReport"` (Source), `PowerReport` (Destination) | No         | The Report type stored by the database  |
+|`model`        | string | `m`           | `"HWPC Report"` (Source), `Power Report` (Destination) | No         | The Report type stored by the database  |
 
 ### JSON File Excerpt
 
@@ -68,7 +68,7 @@ The list of accepted parameters are:
 |`org`          | string | `g`           | N/A           | Yes | The name of the organization associated to the bucket               |
 |`tags`         | string | `t`           | N/A           | No | List of metadata keys of the report separated by `,` that will be kept. `sensor` and `target` are always kept as report metadata                           |
 |`name`         | string | `n`           | `"pusher_influxdb2"` | No                                    | The related pusher name                 |
-|`model`        | string | `m`           | `"PowerReport"`  | No | The Report type stored by the database  |
+|`model`        | string | `m`           | `"Power Report"`  | No | The Report type stored by the database  |
 
 
 InfluxDB2 can only be used as a Destination.
@@ -79,7 +79,7 @@ Below you find an example of configuration excerpt for this kind of Destination.
 
 ```json
 {
-  "model": "PowerReport",
+  "model": "Power Report",
   "type": "influxdb2",
   "uri": "http://127.0.0.1",
   "port": 8086,
@@ -104,7 +104,7 @@ The list of accepted parameters are:
 |`files`(Source)| string  | `f`           | Empty list           | No | The list of input CSV files with the format file1,file2,file3...              |
 |`directory` (Destination and `HWPCSensor`)| string         |`d` (`U` for `HWPCSensor`)          | Current directory           | No |The directory where output CSV files will be written          |
 |`name`         | string | `n`           | `"puller_csv"` (Source), `"pusher_csv"` (Destination)| No | The related puller/pusher name. This parameter is not used by `HWPCSensor`                 |
-|`model`        | string | `m`           | `"HWPCReport"` (Source), `"PowerReport"` (Destination)   | No | The Report type stored in CSV files. This parameter is not used by `HWPCSensor`     |
+|`model`        | string | `m`           | `"HWPC Report"` (Source), `"Power Report"` (Destination)   | No | The Report type stored in CSV files. This parameter is not used by `HWPCSensor`     |
 
 ### JSON File Excerpt
 
@@ -132,7 +132,7 @@ The list of accepted parameters are:
 |`port`         | int    | `P`           | N/A | Yes                                               | The port of communication               |
 |`uri`/ `host`         | int    | `U`           | N/A | Yes                                               | The IP address of the machine running the socket               |
 |`name`         | string | `n`           | `"puller_socket"`| No | The related puller name  |
-|`model`        | string | `m`           | `"HWPCReport"` | No | The Report type managed by the socket |
+|`model`        | string | `m`           | `"HWPC Report"` | No | The Report type managed by the socket |
 
 
 ### JSON File Excerpt
@@ -162,7 +162,7 @@ The list of accepted parameters are:
 | ------------- | -----  | ------------- | -------------| ----------                                        | ------------------------------------    |
 |`filename`     | int    | `f`           | N/A                                                | Yes | The name of the file                    |
 |`name`         | string | `n`           | `"pusher_filedb"` | No | The related pusher name |
-|`model`        | string | `m`           | `"HWPCReport"` (Source) `"PowerReport"` (Destination)| No  | The Report type stored in the file      |
+|`model`        | string | `m`           | `"HWPC Report"` (Source) `"Power Report"` (Destination)| No  | The Report type stored in the file      |
 
 ### JSON File Excerpt
 
@@ -192,7 +192,7 @@ The list of accepted parameters are:
 |`metric-name`  | string | `M`           | N/A | Yes                                              | The exposed metric name                    |
 |`metric-description`  | string | `d`    | `"energy consumption"` | No                             | The exposed metric description                    |
 |`name`         | string | `n`           | `"pusher_prom"` | No | The related pusher name                 |
-|`model`        | string | `m`           | `"PowerReport"` | No | The Report type exposed by Prometheus       |
+|`model`        | string | `m`           | `"Power Report"` | No | The Report type exposed by Prometheus       |
 
 
 Prometheus can only be used as a Destination that monitors reports but they will be not stored by this service.

docs/reference/database/sources_destinations.md

@@ -12,7 +12,7 @@ The table below shows basic parameters.
 | `stream`                             | `bool` (flag)  | `s`           |`False`                               | Real time or post-mortem mode         |
 | `sensor-report-sampling-interval`    | `int`         | N/A           | `1000`                                 | The time in milliseconds between two reports (`stream` = `True`) |
 | `input`     | `string`      | N/A | N/A     | SmartWatts input, shall match an existing Sensor output and contain HPWCReports. See [here](./smartwatts.md#smartwatts-inputs) |
-| `output`     | `string` | N/A | N/A            | SmartWatts output to store PowerReport. See [here](./smartwatts.md#smartwatts-outputs) |
+| `output`     | `string` | N/A | N/A            | SmartWatts output to store Power Report. See [here](./smartwatts.md#smartwatts-outputs) |
 | `pre-processor`     | `string` | N/A | N/A            | Pre-Processor to modify reports generated by a sensor. More information about Processors and their related parameters can be found [here](../processors/processors.md) |
 | `post-processor`     | `string` | N/A | N/A            | Post-Processor to modify reports generated by a formula. More information about Processors and their related parameters can be found [here](../processors/processors.md) |
 

docs/reference/formulas/configuration_files.md

@@ -7,7 +7,7 @@ The RAPL Formula is designed to mesure power consumption of domains (CPU or RAM)
 in real time.
 
 The RAPL Formula takes HWPC Report with RAPL event for each domains. It then
-returns the mesured power in a PowerReport for each domain.
+returns the mesured power in a Power Report for each domain.
 This Formula does not perform any other computation as its goal is only to track
 global power consumption in a more readable way than raw RAPL.
 
@@ -29,7 +29,7 @@ You can use [the following script](../script/rapl_install.sh) to install RAPL Fo
 
 ## Usage
 
-For running the RAPL Formula you need: a Source and a Destination, a Sensor that provides `HWPCReports` and a configuration.
+For running the RAPL Formula you need: a Source and a Destination, a Sensor that provides `HWPC Reports` and a configuration.
 
 ### Source and Destination
 
@@ -42,7 +42,7 @@ docker run -d --name mongo_source_destination -p 27017:27017 mongo
 ```
 
 ### Sensor
-[HWPC Sensor](../sensors/hwpc-sensor.md) is used in order to get `HWPCReports`. Start by installing the HWPC Sensor (see
+[HWPC Sensor](../sensors/hwpc-sensor.md) is used in order to get `HWPC Reports`. Start by installing the HWPC Sensor (see
 [here](../sensors/hwpc-sensor.md#installation)) and start it (see
 [here](../sensors/hwpc-sensor.md#usage)).
 
@@ -69,7 +69,7 @@ Below an example is provided by using MongoDB as Source and Destination.
   "stream": true,
   "input": {
     "puller": {
-      "model": "HWPCReport",
+      "model": "HWPC Report",
       "type": "mongodb",
       "uri": "mongodb://127.0.0.1",
       "db": "test",
@@ -79,7 +79,7 @@ Below an example is provided by using MongoDB as Source and Destination.
   "output": {
     "pusher_power": {
       "type": "mongodb",
-      "model": "PowerReport",
+      "model": "Power Report",
       "type": "mongodb",
       "uri": "mongodb://127.0.0.1",
       "db": "test",
@@ -124,8 +124,8 @@ the installation you use:
      docker run -t \
      --net=host \
      powerapi/powerapi --verbose \
-     --input mongodb --model HWPCReport --uri mongodb://127.0.0.1 --db test --collection prep \
-     --output mongodb --model PowerReport --uri mongodb://127.0.0.1 --db test --collection results \
+     --input mongodb --model HWPC Report --uri mongodb://127.0.0.1 --db test --collection prep \
+     --output mongodb --model Power Report --uri mongodb://127.0.0.1 --db test --collection results \
      --disable-dram-formula \
      --sensor-report-sampling-interval 500
      ```
@@ -134,14 +134,14 @@ the installation you use:
 
     ```sh
     python -m powerapi --verbose \
-    --input mongodb --model HWPCReport --uri mongodb://127.0.0.1 --db test --collection prep \
-    --output mongodb --model PowerReport --uri mongodb://127.0.0.1 --db test --collection results \
+    --input mongodb --model HWPC Report --uri mongodb://127.0.0.1 --db test --collection prep \
+    --output mongodb --model Power Report --uri mongodb://127.0.0.1 --db test --collection results \
     --disable-dram-formula \
     --sensor-report-sampling-interval 500
     ```
 
 ???+ info "Estimations' Storage"
-    Your `PowerReports` will be stored on MongoDB.
+    Your `Power Reports` will be stored on MongoDB.
 
 ???+ tip "Using shortcuts for parameters' names"
     You use `-` instead of `--`.