Skip to content

Commit

Permalink
Fix broken links on the snapshot and restore docs (#197)
Browse files Browse the repository at this point in the history
* docs(snapshot): fix broken links

Signed-off-by: Vishnu Attur <[email protected]>

* docs(snapshot-restore): fix broken links

Signed-off-by: Vishnu Attur <[email protected]>

---------

Signed-off-by: Vishnu Attur <[email protected]>
Signed-off-by: Vikas Gaur <[email protected]>
  • Loading branch information
avishnu authored and vikgaur committed Jan 24, 2024
1 parent f848a22 commit 5c0f991
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 12 deletions.
4 changes: 2 additions & 2 deletions reference/snapshot-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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**.
Expand Down
12 changes: 2 additions & 10 deletions reference/snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}
Expand Down Expand Up @@ -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" %}
Expand All @@ -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))


----------
Expand Down

0 comments on commit 5c0f991

Please sign in to comment.