Google Git
Sign in
apache / kafka-site / refs/heads/jeffkbkim-add-committer
commit8f38ac07a2488cee299bdf80c8139a0244c1a66c[log] [tgz]
authorJeff Kim <kimkb2011@gmail.com>Wed Dec 11 10:52:57 2024 -0500
committerJeff Kim <kimkb2011@gmail.com>Wed Dec 11 10:52:57 2024 -0500
tree2976fc814d42c5a0d88acbc017410b23c4b3c497
parent03d1dc4f50b5c310026d31b604c8a2f433a45b8c [diff]
format
1 file changed
tree: 2976fc814d42c5a0d88acbc017410b23c4b3c497
  1. 0100/
  2. 0101/
  3. 0102/
  4. 0110/
  5. 07/
  6. 08/
  7. 081/
  8. 082/
  9. 090/
  10. 10/
  11. 11/
  12. 20/
  13. 21/
  14. 22/
  15. 23/
  16. 24/
  17. 25/
  18. 26/
  19. 27/
  20. 28/
  21. 30/
  22. 31/
  23. 32/
  24. 33/
  25. 34/
  26. 35/
  27. 36/
  28. 37/
  29. 38/
  30. 39/
  31. api-docs/
  32. css/
  33. diagrams/
  34. documentation/
  35. fonts/
  36. images/
  37. includes/
  38. js/
  39. logos/
  40. .asf.yaml
  41. .gitignore
  42. .htaccess
  43. blog.html
  44. books-and-papers.html
  45. code.html
  46. coding-guide.html
  47. committers.html
  48. contact.html
  49. contributing.html
  50. cve-list.html
  51. Dockerfile
  52. documentation.html
  53. downloads.html
  54. events.html
  55. get-started.html
  56. index.html
  57. intro.html
  58. KEYS
  59. performance.html
  60. podcasts.html
  61. powered-by.html
  62. project-security.html
  63. project.html
  64. protocol.html
  65. quickstart.html
  66. README.md
  67. start-preview.sh
  68. trademark.html
  69. uses.html
  70. videos.html
README.md

How to preview documentation changes locally?

The documentation can be hosted on a local webserver via httpd.

You can run it with the following command, note that it requires docker:

./start-preview.sh

Then you can open localhost:8080 on your browser and browse the documentation.

To kill the process, just type ctrl + c.

How to preview the latest documentation changes in Kafka repository?

  1. Generating document from kafka repository:
# change directory into kafka repository
cd KAFKA_REPO
./gradlew clean siteDocTar
# supposing built with scala 2.13
tar zxvf core/build/distributions/kafka_2.13-$(./gradlew properties | grep version: | awk '{print $NF}' | head -n 1)-site-docs.tgz
  1. Copying the generated documents from Kafka repository into kafka-site, and preview them (note that it requires docker):
# change directory into kafka-site repository
cd KAFKA_SITE_REPO
# copy the generated documents into dev folder
rm -rf dev
mkdir dev
cp -r KAFKA_REPO/site-docs/* dev
# preview it
./start-preview.sh

Then you can open http://localhost:8080/dev/documentation/ on your browser and browse the generated documentation.