Kubernetes-CSI Documentation

This repository contains documentation capturing how to develop and deploy a Container Storage Interface (CSI) driver on Kubernetes.

To access the documentation go to: kubernetes-csi.github.io/docs

To make changes to the documentation, modify the files in book/src and submit a new PR.

Once the PR is reviewed and merged, the CI will automatically generate (using mdbook) the HTML to serve and check it in to src/_book.

To update the CRD API documentation, run:

./hack/gen-api.sh

The script uses the gen-crd-api-reference-docs tool to generate a markdown document for the VolumeSnapshot CRD API. See the script for more information and supported configuration.

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

• Slack channel
• Mailing list

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

To start editing on localhost

$ git clone [email protected]:kubernetes-csi/docs.git
$ cd docs
$ make $(pwd)/mdbook
$ make serve

Access to http:localhost:3000 and you can view a book on localhost!