Skip to content

Commit

Permalink
Merge pull request #2962 from Kavinjsir/fix/build-docs
Browse files Browse the repository at this point in the history 
📖: notify `controller-gen` installation for building book
  • Loading branch information
@k8s-ci-robot
k8s-ci-robot committed Sep 23, 2022
2 parents 4ccb436 + 168150b commit eec9f37
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
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:

1. Follow the instructions at [https://github.com/rust-lang-nursery/mdBook#installation](https://github.com/rust-lang-nursery/mdBook#installation) to
install mdBook.
1. cd into the `docs/book` directory
1. Run `mdbook serve`
1. Visit [http://localhost:3000](http://localhost:3000)
install mdBook.
2. Make sure [controller-gen](https://pkg.go.dev/sigs.k8s.io/controller-tools/cmd/controller-gen) is install in `$GOPATH`.
3. cd into the `docs/book` directory
4. Run `mdbook serve`
5. Visit [http://localhost:3000](http://localhost:3000)

# Steps to deploy

Expand Down

0 comments on commit eec9f37

Please sign in to comment.