Skip to content

Commit f3ebdc6

Browse files
committed
Added a note to help with using Ruby and Jekyll.
1 parent 8b2386b commit f3ebdc6

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,3 +310,11 @@ You can also use a Kafka tool to pull messages from the Topic. If you run this c
310310
it will monitor the topic and output the records as they are delivered:
311311

312312
bin/kafka-console-consumer.sh --bootstrap-server localhost:9092 --topic Authors
313+
314+
## Testing the Docs service
315+
316+
User documents designed to be published with GitHub Pages and are maintained in the /docs directory of the
317+
project. You must have Ruby installed. Additionally, there seems to be a bug with running jekyll with Ruby 3.3.
318+
The server needs to be run with Ruby 3.2.3, so you will need to run `chruby ruby-3.2.3` before starting the jekyll
319+
server. To start the jekyll server, cd into the /docs directory and run the command `bundle exec jekyll server`.
320+
This will start the server and the user documents will be available at http://127.0.0.1:4000/.

0 commit comments

Comments
 (0)