Skip to content

Commit afdfac8

Browse files
authored
Merge pull request #1058 from geezyx/mdbook-readme
Remove GitBook instructions/reference and add mdBook instructions
2 parents 2eebf56 + 61362ec commit afdfac8

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Check out the Kubebuilder [book](https://book.kubebuilder.io).
2626

2727
## Resources
2828

29-
- GitBook: [book.kubebuilder.com](https://book.kubebuilder.io)
29+
- Kubebuilder Book: [book.kubebuilder.io](https://book.kubebuilder.io)
3030
- GitHub Repo: [kubernetes-sigs/kubebuilder](https://github.com/kubernetes-sigs/kubebuilder)
3131
- Slack channel: [#kubebuilder](https://slack.k8s.io/#kubebuilder)
3232
- Google Group: [[email protected]](https://groups.google.com/forum/#!forum/kubebuilder)

docs/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Running GitBook
1+
# Running mdBook
22

3-
1. Follow the instructions at [https://toolchain.gitbook.com/](https://toolchain.gitbook.com/) to
4-
install gitbook.
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.
57
1. cd into the `docs/book` directory
6-
1. Run `gitbook install`
7-
1. Run `gitbook build`
8-
1. Run `gitbook serve`
9-
1. Visit `http://localhost:4000`
8+
1. Run `mdbook serve`
9+
1. Visit [http://localhost:3000](http://localhost:3000)
1010

1111
# Steps to deploy
1212

0 commit comments

Comments
 (0)