sigs.k8s.io/kubebuilder/v3@v3.14.0/docs/README.md (about)

     1  # Running mdBook
     2  
     3  The kubebuilder book is served using [mdBook](https://github.com/rust-lang-nursery/mdBook). If you want to test changes to the book locally, follow these directions:
     4  
     5  1. Follow the instructions at [https://github.com/rust-lang-nursery/mdBook#installation](https://github.com/rust-lang-nursery/mdBook#installation) to
     6     install mdBook.
     7  2. Make sure [controller-gen](https://pkg.go.dev/sigs.k8s.io/controller-tools/cmd/controller-gen) is installed in `$GOPATH`.
     8  3. cd into the `docs/book` directory
     9  4. Run `mdbook serve`
    10  5. Visit [http://localhost:3000](http://localhost:3000)
    11  
    12  # Steps to deploy
    13  
    14  There are no manual steps needed to deploy the website.
    15  
    16  Kubebuilder book website is deployed on Netlify.
    17  There is a preview of the website for each PR.
    18  As soon as the PR is merged, the website will be built and deployed on Netlify.