From ffbfcfc52c0d9eba5cf540078d8a907757fa1e1d Mon Sep 17 00:00:00 2001
From: Eugene Sumin <95425330+e-sumin@users.noreply.github.com>
Date: Fri, 24 Nov 2023 12:43:05 +0100
Subject: [PATCH] Restic related functions deprecation warning in documentation
 (#2471)

* Add warning regarding BackupData deprecation to documentation

* Add warning regarding BackupDataAll deprecation to documentation

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
---
 docs/functions.rst | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/docs/functions.rst b/docs/functions.rst
index 84de34a90a..b6757f4f57 100644
--- a/docs/functions.rst
+++ b/docs/functions.rst
@@ -280,6 +280,10 @@ BackupData
 This function backs up data from a container into any object store
 supported by Kanister.
 
+.. warning::
+   The *BackupData* will be deprecated soon. We recommend using :ref:`copyvolumedata` instead.
+   However, :ref:`restoredata` and :ref:`deletedata` will continue to be available, ensuring you retain control over your existing backups.
+
 .. note::
    It is important that the application includes a ``kanister-tools``
    sidecar container. This sidecar is necessary to run the
@@ -338,6 +342,10 @@ BackupDataAll
 This function concurrently backs up data from one or more pods into an any
 object store supported by Kanister.
 
+.. warning::
+   The *BackupDataAll* will be deprecated soon.
+   However, :ref:`restoredataall` and :ref:`deletedataall` will continue to be available, ensuring you retain control over your existing backups.
+
 .. note::
    It is important that the application includes a ``kanister-tools``
    sidecar container. This sidecar is necessary to run the
@@ -391,7 +399,7 @@ Example:
 RestoreData
 -----------
 
-This function restores data backed up by the BackupData function.
+This function restores data backed up by the :ref:`backupdata` function.
 It creates a new Pod that mounts the PVCs referenced by the specified Pod
 and restores data to the specified path.
 
@@ -536,6 +544,7 @@ BackupDataAll function.
       kind: Deployment
       replicas: 2
 
+.. _copyvolumedata:
 
 CopyVolumeData
 --------------
@@ -589,10 +598,12 @@ If the ActionSet ``Object`` is a PersistentVolumeClaim:
       volume: "{{ .PVC.Name }}"
       dataArtifactPrefix: s3-bucket-name/path
 
+.. _deletedata:
+
 DeleteData
 ----------
 
-This function deletes the snapshot data backed up by the BackupData function.
+This function deletes the snapshot data backed up by the :ref:`backupdata` function.
 
 
 .. csv-table::
@@ -623,6 +634,8 @@ For this phase, we will use the ``backupInfo`` Artifact provided by backup funct
       backupArtifactPrefix: s3-bucket/path/artifactPrefix
       backupTag: "{{ .ArtifactsIn.backupInfo.KeyValue.backupIdentifier }}"
 
+.. _deletedataall:
+
 DeleteDataAll
 -------------