Enrich the doc so that Marmot looks more friendly to new user. #93
Conversation
| job1=$! | ||
|
|
||
| sleep 1 | ||
| ./marmot -config examples/node-2-config.toml -cluster-addr localhost:4222 -cluster-peers 'nats://localhost:4221/' & | ||
| ./marmot -config examples/node-2-config.toml -cluster-addr localhost:4222 -cluster-peers 'nats://localhost:4221/,nats://localhost:4223/' & |
There was a problem hiding this comment.
there is no point of passing :4223 here because that node comes up in very last.
There was a problem hiding this comment.
Understand. But I think this optimization makes new user wondering why. Peer configuration symmertic to node 2 and node 3 is more intutive. Also, when you look at the JetStream doc, it's also using a symetric example.
https://docs.nats.io/running-a-nats-service/configuration/clustering/jetstream_clustering
Indeed, I think specifying two having a different implication in term of HA.
|
|
||
|
|
||
|
|
||
| ## Sample Config File |
There was a problem hiding this comment.
Not sure if copy pasting a sample config is good idea when there is sample config file that is part of package.
There was a problem hiding this comment.
I think it's much better for the doc, but agree copy & paste is not a good idea. Will try to find if there's way to include inline file in mdx.
| @@ -6,35 +6,38 @@ require ( | |||
| github.com/BurntSushi/toml v1.3.2 | |||
| github.com/asaskevich/EventBus v0.0.0-20200907212545-49d423059eef | |||
| github.com/denisbrodbeck/machineid v1.0.1 | |||
| github.com/doug-martin/goqu/v9 v9.18.0 | |||
| github.com/doug-martin/goqu/v9 v9.19.0 | |||
There was a problem hiding this comment.
Let's make sure this file is excluded, since we are only touching documentation files
| @@ -0,0 +1,63 @@ | |||
| package main_test | |||
There was a problem hiding this comment.
I would have these E2E tests in separate PR. Let's keep this PR focused on docs
| @@ -0,0 +1,127 @@ | |||
| package main_test | |||
There was a problem hiding this comment.
Same as below let's keep tests in different PR only go for docs in this PR
No description provided.