Skip to content

Commit d55ea4b

Browse files
authored
fix: broken links (#54)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation Updates** - Enhanced clarity and consistency in documentation through text formatting adjustments and updated links. - Introduced new documentation for the online installation process, guiding users through necessary steps. - Streamlined paths to installation guides, simplifying navigation and accessibility for users. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent dc3741f commit d55ea4b

23 files changed

+41
-39
lines changed

docs/launch-platform/managed-cloud-deployment/1_quickstart.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ sidebar_position: 3
66

77
# Getting Started - Hello World
88

9-
##### This guide will help you explore some of the core building blocks of working with SettleMint even if this is your first time working with a Blockchain.
9+
##### This guide will help you explore some of the core building blocks of working with SettleMint even if this is your first time working with a Blockchain
1010

11-
In this guide you will learn how to [create a blockchain network](../../using-platform/1_add-a-network-to-an-application.md), [deploy a node](../../using-platform/2_add-a-node-to-a-network.md), write a [smart contract](../../using-platform/6_create-smart-contract-set.md) and [create an integration](../../using-platform/9_integration-studio.md).
11+
In this guide you will learn how to [create a blockchain network](../../using-platform/1_add-a-network-to-an-application.md), [deploy a node](../../using-platform/2_add-a-node-to-a-network.md), write a [smart contract](../../using-platform/6_add_smart_contract_sets/0_smart_contracts.md) and [create an integration](../../using-platform/9_integration-studio.md).
1212

1313
Below is both a video and written guide for you to build along to:
1414

@@ -152,9 +152,9 @@ In the IDE, you need to locate and rename the `Example.sol` file that comes incl
152152

153153
![Rename Contract](../../../static/img/quickstart/renamecontract.png)
154154

155-
1. On the left File Explorer panel, find the `contracts` folder and click the arrow to expand.
156-
2. Find the `Example.sol` file in the list
157-
3. Right-click on the file and select `Rename`. Rename the file to `HelloWorld.sol`. This is case-sensitive so make sure you have named it exactly `HelloWorld
155+
1. On the left File Explorer panel, find the `contracts` folder and click the arrow to expand.
156+
2. Find the `Example.sol` file in the list
157+
3. Right-click on the file and select `Rename`. Rename the file to `HelloWorld.sol`. This is case-sensitive so make sure you have named it exactly `HelloWorld
158158

159159
Now you can replace the code that is in the `HelloWorld.sol` file.
160160

@@ -330,7 +330,7 @@ This is done by clicking the name of the private key. There select the `Details`
330330
![Key Created](../../../static/img/quickstart/privatekeycreated.png)
331331
![Alt text](../../../static/img/quickstart/copyprivatekey.png)
332332

333-
With the private key copied, you can now go back to the Integration Studio and paste this key into the first line after `const privateKey = ` inside the ' ''. The private key should begin with `0x`.
333+
With the private key copied, you can now go back to the Integration Studio and paste this key into the first line after `const privateKey =` inside the ' ''. The private key should begin with `0x`.
334334

335335
![Paste Private Key](../../../static/img/quickstart/pasteprivatekey.png)
336336

@@ -346,10 +346,10 @@ SettleMint uses Hardhat scripts to deploy smart contracts. To deploy the Hello W
346346

347347
![Deploy Changes](../../../static/img/quickstart/deploychanges.png)
348348

349-
1. Go to the `deploy` folder in the file explorer on the left
350-
2. Open the `00_deploy_example.ts` file
351-
3. Delete the code that is currently in this file
352-
4. Copy and paste the code below:
349+
1. Go to the `deploy` folder in the file explorer on the left
350+
2. Open the `00_deploy_example.ts` file
351+
3. Delete the code that is currently in this file
352+
4. Copy and paste the code below:
353353

354354
```typescript
355355
import { DeployFunction } from 'hardhat-deploy/types';
@@ -469,10 +469,10 @@ You can now start interacting with the Hello World contract via a front-end page
469469

470470
Your URL will look something similar to this:
471471

472-
Before: `https://helloworld-9ece.gke-europe.settlemint.com/#flow/cfc3eb139dc03dc5`
472+
Before: `https://helloworld-9ece.gke-europe.settlemint.com/#flow/cfc3eb139dc03dc5`
473473
After: `https://helloworld-9ece.gke-europe.settlemint.com/helloworld`
474474

475-
In your browser you will see two options `Read-only ` and `Write`functions:
475+
In your browser you will see two options `Read-only` and `Write`functions:
476476

477477
- `Read-only`: These functions can only read the data from the smart contract
478478

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/_category_.json renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/_category_.json

File renamed without changes.

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/auth-api-requests.md renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/auth-api-requests.md

File renamed without changes.

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/completing-setup-and-deploying.md renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/completing-setup-and-deploying.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You can access the Admin Console to complete the SettleMint Platform setup, run
2727

2828
![CleanShot 2022-10-01 at 13.01.15@2x.png](/img/completing-setup-and-deploying/CleanShot_2022-10-01_at_13.01.152x.png)
2929

30-
- Upload the license file [downloaded from Step 1](../download/download-portal.md)
30+
- Upload the license file [downloaded from Step 1](./download/download-portal.md)
3131

3232
![CleanShot 2022-10-01 at 13.01.29@2x.png](/img/completing-setup-and-deploying/CleanShot_2022-10-01_at_13.01.292x.png)
3333

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/_category_.json renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/_category_.json

File renamed without changes.

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-airgap.md renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-airgap.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ From the SettleMint Download Portal, download the following files
1616
- Full Bundle or Small Bundle : If you choose the small bundle, set up separate pipeline to push images to your repository.
1717
See [below](#understanding-the-structure) for a more detailed explanation.
1818

19-
Continue with [Step 2](../installing-on-an-existing-cluster/install-airgap/install-airgap.md)
19+
Continue with [Step 2](../install-airgap/install-airgap.md)
2020

2121
## Understanding the Structure
2222

@@ -60,5 +60,5 @@ Please note that with this option, upgrading to a another version of the SettleM
6060
- You may also need to get newer versions of the framework software, but our license page will indicate if so.
6161

6262
Once you have downloaded all the files from the link shared with you, you can check that your setup meets the minimum
63-
[requirements](../installing-on-an-existing-cluster/requirements.md) before continuing with the
64-
[installation](../installing-on-an-existing-cluster/install-airgap/install-airgap.md).
63+
[requirements](../requirements.md) before continuing with the
64+
[installation](../install-airgap/install-airgap.md).
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Online Installation
6+
7+
To proceed with the online installation, you only need to download the license file from the download portal.
8+
9+
Check that your setup meets the minimum [requirements](../requirements.md)
10+
before proceeding with the [installation](../install-online/install-online.md).

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-portal.md renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-portal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ There are 3 options to set up the install. Depending on your license, you can ch
3030

3131
- License file
3232
- Installers
33-
- [KOTS CLI](../installing-on-an-existing-cluster/install-airgap/install-kots.md)
34-
- [KOTS admin console](../installing-on-an-existing-cluster/install-airgap/install-kotsadm.md)
33+
- [KOTS CLI](../install-airgap/install-kots.md)
34+
- [KOTS admin console](../install-airgap/install-kotsadm.md)
3535
- SettleMint Platform, comprising of
3636
- Deployer image and scripts
3737
- All the component images

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/_category_.json renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/_category_.json

File renamed without changes.

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/install-airgap.md renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/install-airgap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Install the SettleMint Platform in an Airgap Environment
22

33
When installing the SettleMint Platform on a cluster without internet access, you will need to ensure that you have
4-
followed the steps discribed in the [download section](../../download/download-airgap.md) to download the required license and installation files.
4+
followed the steps discribed in the [download section](../download/download-airgap.md) to download the required license and installation files.
55

66
Airgapped install is only available for licenses that have the airgapped feature enabled.
77

@@ -33,7 +33,7 @@ details on Open Shift command line linkages. 2. **Install the [Admin Console](./
3333

3434
3. **Install the SettleMint Platform application via the Admin Console**
3535

36-
As explained in the [download section](../../download/download-airgap.md),
36+
As explained in the [download section](../download/download-airgap.md),
3737
there are 2 ways to proceed with your airgapped installations: Full or Small Bundles. In the case of **Small**
3838
Bundle, there is an additional step to run the script to push the images to your local registry. You must run this step
3939
**prior** to running the `kots install` command below.

0 commit comments

Comments
 (0)