From f848a22ed060c68fa21b4efe522fbe4d646ab956 Mon Sep 17 00:00:00 2001 From: Vishnu Attur Date: Tue, 23 Jan 2024 23:10:43 +0530 Subject: [PATCH 1/3] docs(snapshot): fix broken links (#196) Signed-off-by: Vishnu Attur Signed-off-by: Vikas Gaur --- reference/snapshot.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/reference/snapshot.md b/reference/snapshot.md index 1a24c6d..ae0cf83 100644 --- a/reference/snapshot.md +++ b/reference/snapshot.md @@ -29,7 +29,7 @@ Currently, Mayastor supports the following operations related to volume snapshot ## Prerequisites -1. Deploy and configure Mayastor by following the steps given [here](quickstart/deploy-mayastor.md) and create disk pools. +1. Deploy and configure Mayastor by following the steps given [here](https://mayastor.gitbook.io/introduction/v/develop/quickstart/deploy-mayastor.md) and create disk pools. 2. Create a Mayastor StorageClass with single replica. {% hint style="note" %} @@ -68,7 +68,11 @@ provisioner: io.openebs.csi-mayastor {% endtab %} {% endtabs %} +<<<<<<< HEAD 3. Create a PVC using [these](quickstart/deploy-a-test-application.md) steps and check if the status of the PVC is **Bound**. +======= +3. Create a PVC using [these](https://mayastor.gitbook.io/introduction/v/develop/quickstart/deploy-a-test-application.md) steps and check if the status of the PVC is **Bound**. +>>>>>>> 914fd74 (docs(snapshot): fix broken links (#196)) {% tabs %} {% tab title="Command" %} @@ -86,7 +90,11 @@ ms-volume-claim Bound pvc-fe1a5a16-ef70-4775-9eac-2f9c67b3cd5b 1Gi > Copy the PVC name, for example, `ms-volume-claim`. +<<<<<<< HEAD 4. (Optional) Create an application by following [these](quickstart/deploy-a-test-application.md) steps. +======= +4. (Optional) Create an application by following [these](../quickstart/deploy-a-test-application.md) steps. +>>>>>>> 914fd74 (docs(snapshot): fix broken links (#196)) ---------- From 113c6c5fb3b81ede74e7b83d7a2b20eecf599fc6 Mon Sep 17 00:00:00 2001 From: Vishnu Attur Date: Tue, 23 Jan 2024 23:39:39 +0530 Subject: [PATCH 2/3] docs: fix broken links (#197) Signed-off-by: Vishnu Attur Signed-off-by: Vikas Gaur --- reference/snapshot-restore.md | 4 ++-- reference/snapshot.md | 12 ++---------- 2 files changed, 4 insertions(+), 12 deletions(-) diff --git a/reference/snapshot-restore.md b/reference/snapshot-restore.md index 38963f9..000d2f8 100644 --- a/reference/snapshot-restore.md +++ b/reference/snapshot-restore.md @@ -8,7 +8,7 @@ Volume restore from an existing snapshot will create an exact replica of a stora ### Step 1: Create a storage class -To begin, you'll need to create a StorageClass that defines the properties of the snapshot to be restored. Refer to [Storage Class Parameters](reference\storage-class-parameters.md) for more details. Use the following command to create the StorageClass: +To begin, you'll need to create a StorageClass that defines the properties of the snapshot to be restored. Refer to [Storage Class Parameters](../reference/storage-class-parameters.md) for more details. Use the following command to create the StorageClass: {% hint style="info" %} thin: "true" and repl: "1" is the only supported combination. @@ -52,7 +52,7 @@ provisioner: io.openebs.csi-mayastor ### Step 2: Create a snapshot -You need to create a volume snapshot before proceeding with the restore. Follow the steps outlined in [this guide](quickstart/snapshot.md) to create a volume snapshot. +You need to create a volume snapshot before proceeding with the restore. Follow the steps outlined in [this guide](../quickstart/snapshot.md) to create a volume snapshot. > Note the snapshot's name, for example, **pvc-snap-1**. diff --git a/reference/snapshot.md b/reference/snapshot.md index ae0cf83..bf93a15 100644 --- a/reference/snapshot.md +++ b/reference/snapshot.md @@ -29,7 +29,7 @@ Currently, Mayastor supports the following operations related to volume snapshot ## Prerequisites -1. Deploy and configure Mayastor by following the steps given [here](https://mayastor.gitbook.io/introduction/v/develop/quickstart/deploy-mayastor.md) and create disk pools. +1. Deploy and configure Mayastor by following the steps given [here](../quickstart/deploy-mayastor.md) and create disk pools. 2. Create a Mayastor StorageClass with single replica. {% hint style="note" %} @@ -68,11 +68,7 @@ provisioner: io.openebs.csi-mayastor {% endtab %} {% endtabs %} -<<<<<<< HEAD -3. Create a PVC using [these](quickstart/deploy-a-test-application.md) steps and check if the status of the PVC is **Bound**. -======= -3. Create a PVC using [these](https://mayastor.gitbook.io/introduction/v/develop/quickstart/deploy-a-test-application.md) steps and check if the status of the PVC is **Bound**. ->>>>>>> 914fd74 (docs(snapshot): fix broken links (#196)) +3. Create a PVC using [these](../quickstart/deploy-a-test-application.md) steps and check if the status of the PVC is **Bound**. {% tabs %} {% tab title="Command" %} @@ -90,11 +86,7 @@ ms-volume-claim Bound pvc-fe1a5a16-ef70-4775-9eac-2f9c67b3cd5b 1Gi > Copy the PVC name, for example, `ms-volume-claim`. -<<<<<<< HEAD -4. (Optional) Create an application by following [these](quickstart/deploy-a-test-application.md) steps. -======= 4. (Optional) Create an application by following [these](../quickstart/deploy-a-test-application.md) steps. ->>>>>>> 914fd74 (docs(snapshot): fix broken links (#196)) ---------- From 8fc81bb13299e914491985cd2b41f3cd2f2c6766 Mon Sep 17 00:00:00 2001 From: Vishnu Attur Date: Wed, 24 Jan 2024 00:02:43 +0530 Subject: [PATCH 3/3] docs: fix broken links (#198) Signed-off-by: Vishnu Attur Signed-off-by: Vikas Gaur --- quickstart/deploy-mayastor.md | 2 +- reference/snapshot-restore.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/quickstart/deploy-mayastor.md b/quickstart/deploy-mayastor.md index 215ae77..ac49954 100644 --- a/quickstart/deploy-mayastor.md +++ b/quickstart/deploy-mayastor.md @@ -3,7 +3,7 @@ ## Overview {% hint style="note" %} -Before deploying and using Mayastor please consult the [Known Issues](https://mayastor.gitbook.io/introduction/quickstart/known-issues) section of this guide. +Before deploying and using Mayastor please consult the [Known Issues](../quickstart/known-issues.md) section of this guide. {% endhint %} The steps and commands which follow are intended only for use in conjunction with Mayastor version(s) 2.1.x and above. diff --git a/reference/snapshot-restore.md b/reference/snapshot-restore.md index 000d2f8..47145cf 100644 --- a/reference/snapshot-restore.md +++ b/reference/snapshot-restore.md @@ -52,7 +52,7 @@ provisioner: io.openebs.csi-mayastor ### Step 2: Create a snapshot -You need to create a volume snapshot before proceeding with the restore. Follow the steps outlined in [this guide](../quickstart/snapshot.md) to create a volume snapshot. +You need to create a volume snapshot before proceeding with the restore. Follow the steps outlined in [this guide](../reference/snapshot.md) to create a volume snapshot. > Note the snapshot's name, for example, **pvc-snap-1**.