Skip to content

Commit 9b4f712

Browse files
Fix/documentation fixes (#13)
Fixed - links all over the the new installation docs - typos - Replace a duplicated guide that was in one of the files <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated and added installation guides for SettleMint Blockchain Transformation Platform (BTP) on Kubernetes. - Introduced new category labels for better organization. - Provided support, troubleshooting guidance, and quick start examples for trial installations. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: saeeddawod <[email protected]>
1 parent 275ff32 commit 9b4f712

File tree

7 files changed

+15162
-136
lines changed

7 files changed

+15162
-136
lines changed

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/introduction.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ Welcome to the SettleMint Blockchain Transformation Platform (BTP) guide. This g
1212
- [Understand the installation process](#understand-the-installation-process)
1313
- [Quick Start & Trial installations](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/installation-trial-cluster/)
1414
- [Prerequisites](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure/)
15-
- [Run the Installation](#)
16-
- [Get Support](#)
15+
16+
- [Run the Installation](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/)
17+
- [Get Support](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/support-and-troubleshooting/)
1718

1819
## Introduction
1920

@@ -25,7 +26,7 @@ It also provides numerous benefits, such as enabling you to specify the high ava
2526

2627
<!-- DIAGRAM HERE -->
2728

28-
After finishing the installation, you will have access to a suite of services and tools designed to support you throughout your blockchain journey. To explore these tools in detail, we invite you to visit our [Developer Hub](#).
29+
After finishing the installation, you will have access to a suite of services and tools designed to support you throughout your blockchain journey. To explore these tools in detail, we invite you to visit our [Developer Hub](/docs/about-settlemint/intro/).
2930

3031
- **Public chains**: Polygon PoS, Polygon zkevm, Ethereum, Avalanche, Arbitrum, Optimism, Binance Smart Chain *(Internet access required)*
3132
- **Private chains**: Hyperledger Besu, Quorum, Hyperledger Fabric
@@ -35,7 +36,7 @@ After finishing the installation, you will have access to a suite of services an
3536
- **Integrated IDE**: Including smart contract sets
3637
- **Smart contract Indexer**: The Graph Middleware
3738

38-
It's essential to remember that preparing your infrastructure and necessary services is a [prerequisite](link). Once this foundation is established, you'll need to populate the helm charts values file, as detailed in the subsequent "Platform installation” section.
39+
It's essential to remember that preparing your infrastructure and necessary services is a [prerequisite](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure/). Once this foundation is established, you'll need to populate the helm charts values file, as detailed in the subsequent "Platform installation” section.
3940

4041
## Understand the Installation Process
4142

@@ -54,7 +55,8 @@ Should you encounter any issues or have questions during any phase of the instal
5455

5556

5657
Next:
57-
- [Explore one of our trial installations](#) to get a hands-on feel for the platform
58-
- [Proceed to the prerequisites page](#) to prepare for a full installation
58+
- [Explore one of our trial installations](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/installation-trial-cluster/) to get a hands-on feel for the platform
59+
- [Proceed to the prerequisites page](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure/) to prepare for a full installation
60+
5961

6062

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ Before starting the installation, ensure your environment meets the following re
77

88
# Infrastructure
99

10-
The following components are a prerequisite to run BTP successfully. Collect the values here to use them later in the [helm chart values file](#).
10+
11+
The following components are a prerequisite to run BTP successfully. Collect the values here to use them later in the [helm chart values file](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/).
1112

1213
At this stage, we highly recommend taking a moment to explore our quick start examples, if you haven't already. This will give you a valuable overview of the different components involved.
1314

@@ -40,7 +41,8 @@ For the successful operation of the SettleMint Blockchain Transformation Platfor
4041

4142
- `hostname`: the hostname on which BTP will be available. This domain name needs to be routed to the public IP address of the ingress controller service.
4243

43-
[In your values file](#)
44+
[In your values file](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/)
45+
4446

4547
```yaml
4648
ingress:
@@ -90,8 +92,7 @@ keycloak:
9092
clientSecret: ""
9193
issuerURL: ""
9294
```
93-
94-
[In your values file](#)
95+
[In your values file](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/)
9596

9697
```yaml
9798
auth:
@@ -114,9 +115,7 @@ A typical set of parameters you should collect:
114115
- port: the port of the redis server
115116
- password: the password of the redis server
116117

117-
118-
119-
[In your values file](#)
118+
[In your values file](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/)
120119

121120
```yaml
122121
redis:
@@ -138,7 +137,8 @@ If you don't currently have a PostgreSQL server, you can set it up yourself by f
138137
- `password`: the password of the PostgreSQL server
139138
- `database`: the database name of the PostgreSQL server
140139

141-
[In your values file](#)
140+
[In your values file](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/)
141+
142142

143143
```yaml
144144
postgresql:
@@ -162,7 +162,7 @@ The state information is always encrypted. By default, encryption is performed u
162162
- `accessKeyId`: This is the access key for the specified bucket.
163163
- `secretAccessKey`: This is the secret access key for the specified bucket.
164164

165-
[In your values file](#)
165+
[In your values file](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/)
166166

167167
```yaml
168168
state:
@@ -186,7 +186,7 @@ Additionally, an AppRole is necessary to facilitate access to these secrets.
186186
- `roleId`: the roleId of the AppRole
187187
- `secretId`: the secretId of the AppRole
188188

189-
[In your values file](#)
189+
[In your values file](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/)
190190

191191
```yaml
192192
vault:
@@ -206,7 +206,8 @@ This observability suite is optional and can be activated as described below.
206206
- Prometheus API URL: this is an example from Grafana cloud: `https://prometheus-prod-01-eu-west-0.grafana.net/api/prom/api/v1/`
207207
- Loki API URL: this is an example from Grafana cloud: `https://logs-prod-eu-west-0.grafana.net/loki/api/v1/`
208208

209-
[In your values file](#)
209+
[In your values file](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/)
210+
210211

211212
```yaml
212213
features:
@@ -255,7 +256,9 @@ To facilitate this, activate **p2pLoadBalancers** and configure DNS name managem
255256

256257
In addition, the 'mixedLoadBalancers' option facilitates the creation of TCP/UDP load balancers on the same port, which is essential for enabling discovery mechanisms.
257258

258-
[In your values file](#)
259+
260+
[In your values file](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/)
261+
259262

260263
```yaml
261264
targets:

0 commit comments

Comments
 (0)