Skip to content

docs: docs site setup#88

Merged
vaibhavtiwari33 merged 7 commits into
mainfrom
docs-site-setup
Apr 23, 2026
Merged

docs: docs site setup#88
vaibhavtiwari33 merged 7 commits into
mainfrom
docs-site-setup

Conversation

@ccm32004

@ccm32004 ccm32004 commented Apr 23, 2026

Copy link
Copy Markdown
Collaborator

configured documentation site for apache pulsar: https://numaproj-contrib.github.io/apache-pulsar-java/docs-site/

  • rewrote some of the documentation to be less verbose
  • added comments to classes for javadoc
  • includes user facing docs for usage of apache pulsar, and developer facing docs (api reference, for class/method definitions)
  • uses javadocs, which automatically takes comments and generates documents site
  • user-facing docs (getting started, source/sink usage, testing) written as Markdown under docs/, rendered via MkDocs with the Material theme.
  • added automated script that copies the site files into deployed branch gh-pages (builds Javadoc + MkDocs, publishes via a temporary gh-pages worktree).

Testing notes

  • tested automated script to add new changes to site with no bugs

Signed-off-by: Cece Ma <mayuqing131@gmail.com>
@github-actions

github-actions Bot commented Apr 23, 2026

Copy link
Copy Markdown

Code Coverage

Percentage of source code lines executed by unit tests.

Overall Project 82.73%
Files changed 100%

File Coverage
PulsarAdminProperties.java 100%
PulsarAdminConfig.java 100%
PulsarClientProperties.java 100%
PulsarClientConfig.java 100%
PulsarProducerProperties.java 100%
EnvLookup.java 100%
PulsarProducerConfig.java 93.51%
PulsarConfigLoader.java 93.26%
PulsarSink.java 78.86%
PulsarSource.java 78.8%
PulsarConsumerProperties.java 77.02%
PulsarConsumerManager.java 61.9%

@github-actions

github-actions Bot commented Apr 23, 2026

Copy link
Copy Markdown

Continuous benchmark

Config: batch size = 500

Compared to the latest result on gh-pages (last main run that updated charts). Regression when a metric degrades by more than vs baseline.

Metric This run Baseline (main) Change Status
Consumer Throughput 33116.67 msgs/sec 33833.33 msgs/sec -2.1% OK
Processing Latency (per batch) 15.11 ms 14.79 ms +2.2% OK
Read Latency (per batch) 7.53 ms 7.34 ms +2.6% OK
Ack Latency (per batch) 0.56 ms 0.54 ms +3.7% OK
Consumer CPU 1327 millicores 1323 millicores +0.3% OK
Consumer Memory 342 MiB 339 MiB +0.9% OK

Result: No regression beyond the threshold vs main baseline.

Workflow run
· GitHub Pages charts

Signed-off-by: Cece Ma <mayuqing131@gmail.com>
Signed-off-by: Cece Ma <mayuqing131@gmail.com>
Signed-off-by: Cece Ma <mayuqing131@gmail.com>
Signed-off-by: Cece Ma <mayuqing131@gmail.com>
Signed-off-by: Cece Ma <mayuqing131@gmail.com>
@ccm32004 ccm32004 changed the title docs: site setup docs: docs site setup Apr 23, 2026
Signed-off-by: Cece Ma <mayuqing131@gmail.com>
@ccm32004 ccm32004 marked this pull request as ready for review April 23, 2026 20:46
@vaibhavtiwari33 vaibhavtiwari33 merged commit 32f0298 into main Apr 23, 2026
5 checks passed
@vaibhavtiwari33 vaibhavtiwari33 deleted the docs-site-setup branch April 23, 2026 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants