Skip to content

Commit bdb72ca

Browse files
authored
update tutorial pages (#96)
1 parent 77020f2 commit bdb72ca

19 files changed

Lines changed: 62 additions & 61 deletions

content/protocol/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 📔 Protocol
2+
title: 📚 Protocol
33
weight: 2
44
prev: /get-started/
55
next: /tutorials/

content/protocol/consensus/proof-of-stake.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Solid State Proof of Stake
2+
title: Solid-State Proof of Stake
33
weight: 1
44
---
55

content/protocol/consensus/protocol.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Protocol
2+
title: Consensus Protocol
33
weight: 2
44
math: true
55
---

content/protocol/transaction/format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Format
2+
title: Transaction Format
33
weight: 1
44
math: false
55
---

content/tutorials/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 📚 Tutorials
2+
title: 🎓 Tutorials
33
weight: 3
44
prev: /protocol/
55
next: /api/

content/tutorials/grpc-basic-auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: How to Secure gRPC Using Basic Authentication?
2+
title: Secure gRPC Using Basic Authentication
33
weight: 6
44
---
55

@@ -67,7 +67,7 @@ For additional security, you can save the web page locally and run it on an offl
6767
</button>
6868
<br>
6969
<br>
70-
<p id="output"></p>
70+
<div id="output" class="hextra-code-block"></div>
7171
</form>
7272

7373
## Enable Basic Auth in the Config

content/tutorials/grpc-sign-transactions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: How to Sign Transactions Using gRPC?
2+
title: Sign Transactions Using gRPC
33
weight: 5
44
---
55

content/tutorials/linux-systemd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: How to Run Pactus with systemd on Linux?
2+
title: Run Pactus with systemd on Linux
33
weight: 10
44
---
55

@@ -21,7 +21,7 @@ Before setting up Pactus to run with systemd, ensure you have the following:
2121

2222
To create a systemd service for Pactus, follow these steps:
2323

24-
1. **Initialize the Pactus Node**: Before running the service, initialize the Pactus node by this command:
24+
1. **Initialize the Pactus Node**: Before running the service, initialize the Pactus node with this command:
2525

2626
```shell
2727
pactus-daemon init

content/tutorials/pactus-metrics.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: How to run Pactus Metrics?
2+
title: Run Pactus Metrics
33
weight: 9
44
---
55

@@ -17,20 +17,20 @@ Before proceeding with the steps below, ensure that you have the following:
1717

1818
## Configure Pactus Node for Metrics
1919

20-
To Configure the Pactus Node for Metrics, navigate to the Pactus directory; by default, it’s located at the following path.
20+
To configure the Pactus node for metrics, navigate to the Pactus directory. By default, it’s located at:
2121

2222
```text
2323
/home/YourUsername/pactus
2424
```
2525

2626
There’s a file named `config.toml` that contains all the configurations for your node.
27-
There are two parameters that you should enable for metrics: the first is `enable_metrics`,
28-
and the second is enable `http`. After editing the `config.toml` you should restart your node.
29-
The metrics now can be accessed at `http://localhost:80/metrics/prometheus` (this url going to be use by prometheus).
27+
Enable two parameters for metrics: `enable_metrics` and `http.enable`.
28+
After editing `config.toml`, restart your node.
29+
Metrics are available at `http://localhost:80/metrics/prometheus` (this URL will be used by Prometheus).
3030

3131
{{< callout type="info" >}}
3232

33-
if you are running Pactus with docker image, make sure to expose :80 port.
33+
If you are running Pactus with the Docker image, make sure to expose port 80.
3434

3535
{{< /callout >}}
3636

@@ -70,9 +70,8 @@ volumes: prom_data
7070
```
7171
7272
You can change the default username and password of Grafana by modifying the values of `GF_SECURITY_ADMIN_USER` and `GF_SECURITY_ADMIN_PASSWORD`.
73-
Now, save the file. Then, in the current directory (meaning you are inside the `prometheus-grafana` directory),
74-
create another directory named `grafana`. Then, go to the directory. So now you're in the path `/prometheus-grafana/grafana/`.
75-
In the current directory, create a file named `datasource.yml` and paste the code below there.
73+
Save the file. From the same `prometheus-grafana` directory, create a `grafana` directory and enter it (`/prometheus-grafana/grafana/`).
74+
In that directory, create a file named `datasource.yml` and paste the code below.
7675

7776
```yaml
7877
apiVersion: 1
@@ -86,10 +85,9 @@ datasources:
8685
editable: true
8786
```
8887

89-
Then save the file and exit.
90-
Now, we should go up one directory level from the current directory and navigate to the `/prometheus-grafana` directory.
91-
In the current directory, which is `/prometheus-grafana`, create another directory named `prometheus`,
92-
then go into the directory.In the prometheus directory create a file named `prometheus.yml` and paste below code there.
88+
Save the file and exit.
89+
Go up one directory level back to `/prometheus-grafana`.
90+
Create a `prometheus` directory, enter it, and create a file named `prometheus.yml` with the content below.
9391

9492
```yaml
9593
global:
@@ -119,10 +117,10 @@ Then save the file and exit.
119117

120118
{{< callout type="info" >}}
121119

122-
Tip: In the last section of the code, you will see the targets section where I've written 127.0.0.1.
123-
You can change it based on your localhost IP or your website domain.
124-
Please be aware that your target should match with your node http port.
125-
The default http port of pactus node is 80.
120+
Tip: In the last section of the code, you will see the targets section where 127.0.0.1 is set.
121+
You can change it based on your localhost IP or your domain.
122+
Please ensure that your target matches your node's HTTP port.
123+
The default HTTP port of a Pactus node is 80.
126124

127125
{{< /callout >}}
128126

content/tutorials/pactus-shell.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: How to use Pactus Shell?
2+
title: Use Pactus Shell
33
weight: 3
44
---
55

66
Pactus Shell is a command-line tool designed for interacting with the Pactus blockchain.
7-
This tool receives the commands from the terminal and send them to the node using gRPC.
8-
The resulting response is then displayed as a structured [JSON](https://www.json.org) format.
7+
This tool receives commands from the terminal and sends them to the node using gRPC.
8+
The resulting response is then displayed in a structured [JSON](https://www.json.org) format.
99

1010
You can execute `pactus-shell` with the `-h` flag to display available commands for communicating with your node.
1111

0 commit comments

Comments
 (0)