helpshift / helpshift/ekaf

Incorrect instructions in ekaf_demo?

Open
#4 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Erlang
Stars
164
Forks
49
PR merge metrics
No merged PRs in 30d

Description

Following https://github.com/helpshift/ekaf/blob/master/src/ekaf_demo.erl#L6 I get:

```
kafkamocker $ rebar compile skip_deps=true && erl -pa ebin -pa deps/*/ebin -s kafkamocker_demo
==> kafkamocker (compile)
Erlang/OTP 17 [erts-6.2] [source] [64-bit] [smp:4:4] [async-threads:10] [kernel-poll:false]

{"init terminating in do_boot",{undef,[{kafkamocker_demo,start,[],[]},{init,start_it,1,[]},{init,start_em,1,[]}]}}

Crash dump was written to: erl_crash.dump
init terminating in do_boot ()
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Read src/ekaf_demo.erl at the linked line and reproduce the documented rebar compile and erl command. Compare the command with the module and entry point named by the resulting undef error; update the instructions so the documented command starts the demo successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
erlang
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.