cluster-api-provider-rke2/docs/book
Furkat Gofurov 4fba78c0d2
Prepare main branch for releasing 0.21
Signed-off-by: Furkat Gofurov <furkat.gofurov@suse.com>
2025-10-24 11:28:24 +03:00
..
src Prepare main branch for releasing 0.21 2025-10-24 11:28:24 +03:00
.gitignore docs: Add book for CAPRKE2 2024-08-22 16:43:19 +01:00
Makefile docs: Add book for CAPRKE2 2024-08-22 16:43:19 +01:00
README.md docs: Fix links and include a README that describes how to work with mdBook locally 2024-08-22 16:43:20 +01:00
book.toml docs: Add book for CAPRKE2 2024-08-22 16:43:19 +01:00
util-embed.sh docs: Add book for CAPRKE2 2024-08-22 16:43:19 +01:00

README.md

Preview book changes locally

It is easy to preview your local changes to the book before submitting a PR:

  1. Build the local copy of the book from the docs/book path:

    make build
    
  2. To preview the book contents run:

    make serve
    

This should serve the book at localhost:3000. You can keep running make serve and continue making doc changes. mdBook will detect your changes, render them and refresh your browser page automatically.

  1. Clean mdBook auto-generated content from docs/book/book path once you have finished local preview:

    make clean