From 35cffb92b1ae6aebdde87fdc1f1f8c5bade8fa9b Mon Sep 17 00:00:00 2001 From: yati1998 Date: Mon, 14 Oct 2024 17:42:02 +0530 Subject: [PATCH] doc: resturcture the doc folder This commit is the restructure the doc folder to include sub-folders like csi-addons, rbd, cephfs to contain related docs and other general docs can be placed under doc folder. This will enhance the doc structure will make it easier for the users to search the docs as it get more populated. Signed-off-by: yati1998 --- deploy/cephfs/kubernetes/cephfs.md | 1 + deploy/rbd/kubernetes/rbd.md | 1 + docs/{deploy-cephfs.md => cephfs/deploy.md} | 0 docs/{ => csi-addons}/disaster-recovery.md | 0 docs/{ => design/proposals}/ceph-mount-corruption.md | 0 docs/{ => design/proposals}/cephfs-snapshot-backed-volumes.md | 0 docs/{ => design/proposals}/rbd-nbd.md | 0 docs/{deploy-rbd.md => rbd/deploy.md} | 0 8 files changed, 2 insertions(+) create mode 120000 deploy/cephfs/kubernetes/cephfs.md create mode 120000 deploy/rbd/kubernetes/rbd.md rename docs/{deploy-cephfs.md => cephfs/deploy.md} (100%) rename docs/{ => csi-addons}/disaster-recovery.md (100%) rename docs/{ => design/proposals}/ceph-mount-corruption.md (100%) rename docs/{ => design/proposals}/cephfs-snapshot-backed-volumes.md (100%) rename docs/{ => design/proposals}/rbd-nbd.md (100%) rename docs/{deploy-rbd.md => rbd/deploy.md} (100%) diff --git a/deploy/cephfs/kubernetes/cephfs.md b/deploy/cephfs/kubernetes/cephfs.md new file mode 120000 index 00000000000..e05eaa04c9d --- /dev/null +++ b/deploy/cephfs/kubernetes/cephfs.md @@ -0,0 +1 @@ +../../../docs/cephfs/deploy.md \ No newline at end of file diff --git a/deploy/rbd/kubernetes/rbd.md b/deploy/rbd/kubernetes/rbd.md new file mode 120000 index 00000000000..3ae0050c774 --- /dev/null +++ b/deploy/rbd/kubernetes/rbd.md @@ -0,0 +1 @@ +../../../docs/rbd/deploy.md \ No newline at end of file diff --git a/docs/deploy-cephfs.md b/docs/cephfs/deploy.md similarity index 100% rename from docs/deploy-cephfs.md rename to docs/cephfs/deploy.md diff --git a/docs/disaster-recovery.md b/docs/csi-addons/disaster-recovery.md similarity index 100% rename from docs/disaster-recovery.md rename to docs/csi-addons/disaster-recovery.md diff --git a/docs/ceph-mount-corruption.md b/docs/design/proposals/ceph-mount-corruption.md similarity index 100% rename from docs/ceph-mount-corruption.md rename to docs/design/proposals/ceph-mount-corruption.md diff --git a/docs/cephfs-snapshot-backed-volumes.md b/docs/design/proposals/cephfs-snapshot-backed-volumes.md similarity index 100% rename from docs/cephfs-snapshot-backed-volumes.md rename to docs/design/proposals/cephfs-snapshot-backed-volumes.md diff --git a/docs/rbd-nbd.md b/docs/design/proposals/rbd-nbd.md similarity index 100% rename from docs/rbd-nbd.md rename to docs/design/proposals/rbd-nbd.md diff --git a/docs/deploy-rbd.md b/docs/rbd/deploy.md similarity index 100% rename from docs/deploy-rbd.md rename to docs/rbd/deploy.md