ceph-csi
ceph-csi copied to clipboard
ceph
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.
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
we can have a deploy folder for deployments instead of having separate folder in the doc itself.
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! This way we will have better accessibility.
we can have a deploy folder for deployments instead of having separate folder in the doc itself.
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.
sounds good to me
![mergify[bot] avatar](https://avatars.githubusercontent.com/in/10562?v=4 "Published by a pub.dev verified publisher"){kind=small}
queue
✅ The pull request has been merged automatically
The pull request has been merged automatically at a6f1af49c649f90047f466423785ed006190e247
