doc: resturcture the doc folder #4907
Conversation
mergify
bot
added
ci/skip/e2e
There was a problem hiding this comment.
we need to move the mount corruption doc to design and same for cephfs snapshot backed volumes as well and for rbd-nbd as well.
we can have a deploy folder for deployments instead of having separate folder in the doc itself.
@Nikhil-Ladha @Rakshith-R any thoughts?
|
While moving the file into new directories per component, you can remove the redundant component name in the filename. For example: docs/deploy-rbd.md → docs/rbd/deploy.md |
I agree if you mean moving the files like this: docs/deploy-rbd.md → deploy/rbd.md Possibly add a symlink like docs/rbd/deploy.md pointing to the deploy/rbd.md file. |
|
Moving to deploy folder and having symlink sounds good! |
sounds good to me |
yati1998
force-pushed
the
doc-structure
branch
from
1e542e0
to
1603482
Compare
deploy/rbd/deploy.md
Outdated
| @@ -0,0 +1 @@ | |||
| docs/rbd/deploy.md | |||
There was a problem hiding this comment.
accessing symlink failed for me, can you please cross check this and see if you are able to access the file if you open it from deploy folder?
There was a problem hiding this comment.
yes, shows error while opening, will check on that
There was a problem hiding this comment.
it works now, please do review it again
yati1998
force-pushed
the
doc-structure
branch
from
1603482
to
c5b5707
Compare
|
\retest |
|
@Mergifyio rebase |
✅ Branch has been successfully rebased |
Madhu-1
force-pushed
the
doc-structure
branch
from
c5b5707
to
35cffb9
Compare
|
@Mergifyio queue |
✅ The pull request has been merged automaticallyThe pull request has been merged automatically at a6f1af4 |
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 <ypadia@redhat.com>
yati1998
force-pushed
the
doc-structure
branch
from
35cffb9
to
e618f31
Compare
|
/test ci/centos/k8s-e2e-external-storage/1.30 |
|
/test ci/centos/mini-e2e-helm/k8s-1.30 |
|
/test ci/centos/mini-e2e/k8s-1.30 |
|
/test ci/centos/k8s-e2e-external-storage/1.29 |
|
/test ci/centos/upgrade-tests-cephfs |
|
/test ci/centos/mini-e2e-helm/k8s-1.29 |
|
/test ci/centos/k8s-e2e-external-storage/1.31 |
|
/test ci/centos/upgrade-tests-rbd |
|
/test ci/centos/mini-e2e-helm/k8s-1.31 |
|
/test ci/centos/mini-e2e/k8s-1.29 |
|
/test ci/centos/mini-e2e/k8s-1.31 |
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.