Google Git
Sign in
apache / kafka-site / 7c21bef2f9f32dee965a79f9243e49eafb354d81
commit7c21bef2f9f32dee965a79f9243e49eafb354d81[log] [tgz]
authorIgor Soarez <i@soarez.me>Sun Jun 30 23:31:52 2024 +0200
committerGitHub <noreply@github.com>Sun Jun 30 22:31:52 2024 +0100
tree176baa4486251c29b65dc2d4159956082ac54aa0
parent6de540aedec66d2d044655a9c1383ecae05d1dc3 [diff]
Add blog post for 3.7.1 (#605)
1 file changed
tree: 176baa4486251c29b65dc2d4159956082ac54aa0
  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. api-docs/
  30. css/
  31. diagrams/
  32. documentation/
  33. fonts/
  34. images/
  35. includes/
  36. js/
  37. logos/
  38. .asf.yaml
  39. .gitignore
  40. .htaccess
  41. blog.html
  42. books-and-papers.html
  43. code.html
  44. coding-guide.html
  45. committers.html
  46. contact.html
  47. contributing.html
  48. cve-list.html
  49. Dockerfile
  50. documentation.html
  51. downloads.html
  52. events.html
  53. get-started.html
  54. index.html
  55. intro.html
  56. KEYS
  57. performance.html
  58. podcasts.html
  59. powered-by.html
  60. project-security.html
  61. project.html
  62. protocol.html
  63. quickstart.html
  64. README.md
  65. start-preview.sh
  66. trademark.html
  67. uses.html
  68. 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.